Merge pull request #749 from olivier-stasse/master

Fix #748 building jrl-cmake documentation on Ubuntu 24.04 LTS

Author: nim65s

.docs/cmake.py

@@ -330,4 +330,4 @@ def setup(app):
     app.add_config_value("currentmode", "user", "env")
     app.add_directive("setmode", SetMode)
     app.add_directive("ifmode", IfMode)
-    app.add_stylesheet("css/cmake.css")
+    app.add_css_file("css/cmake.css")

.docs/conf.py

@@ -1,23 +1,15 @@
 Basics
 ******
 
-Setup the project
-=================
-.. cmake-module:: ../../base.cmake
+.. cmakemodule:: ../../base.cmake
 
-C++ Headers
-===========
-.. cmake-module:: ../../header.cmake
+.. cmakemodule:: ../../header.cmake
 
-Version
-===========
 .. setmode:: user
 
-.. cmake-module:: ../../version.cmake
+.. cmakemodule:: ../../version.cmake
 
-Set a minimal C++ standard
-==========================
-.. cmake-module:: ../../cxx-standard.cmake
+.. cmakemodule:: ../../cxx-standard.cmake
 
 .. _minimal-working-example:
 
@@ -29,4 +21,4 @@ Minimal working example
 
 Code documentation using Doxygen
 ================================
-.. cmake-module:: ../../doxygen.cmake
+.. cmakemodule:: ../../doxygen.cmake

.docs/pages/base.rst

@@ -24,7 +24,7 @@ appended to the end of the config script.
 Consuming packages
 ==================
 
-.. cmake-module:: ../../package-config.cmake
+.. cmakemodule:: ../../package-config.cmake
 
 Minimal working example with CMake packages
 ===========================================

.docs/pages/cmake-packages.rst

@@ -10,14 +10,14 @@ flags. In particular, it allows to specify dependencies towards other projects b
 
 .. setmode:: import
 
-.. cmake-module:: ../../pkg-config.cmake
+.. cmakemodule:: ../../pkg-config.cmake
 
 pkg-config generation
 =====================
 
 .. setmode:: export
 
-.. cmake-module:: ../../pkg-config.cmake
+.. cmakemodule:: ../../pkg-config.cmake
 
 .. setmode:: user
 
@@ -26,13 +26,13 @@ External dependencies
 
 Eigen
 -----
-.. cmake-module:: ../../eigen.cmake
+.. cmakemodule:: ../../eigen.cmake
 Boost
 -----
-.. cmake-module:: ../../boost.cmake
+.. cmakemodule:: ../../boost.cmake
 Python
 ------
-.. cmake-module:: ../../python.cmake
+.. cmakemodule:: ../../python.cmake
 
 Advanced
 ========
@@ -42,13 +42,13 @@ pkg-config dependencies
 
 .. setmode:: import-advanced
 
-.. cmake-module:: ../../pkg-config.cmake
+.. cmakemodule:: ../../pkg-config.cmake
 
 pkg-config generation
 ---------------------
 
 .. setmode:: export-advanced
 
-.. cmake-module:: ../../pkg-config.cmake
+.. cmakemodule:: ../../pkg-config.cmake
 
 .. setmode:: user

.docs/pages/dependencies.rst

@@ -3,11 +3,11 @@ Internal commands
 
 .. setmode:: internal
 
-.. cmake-module:: ../../version.cmake
-.. cmake-module:: ../../pkg-config.cmake
-.. cmake-module:: ../../header.cmake
-.. cmake-module:: ../../cxx-standard.cmake
+.. cmakemodule:: ../../version.cmake
+.. cmakemodule:: ../../pkg-config.cmake
+.. cmakemodule:: ../../header.cmake
+.. cmakemodule:: ../../cxx-standard.cmake
 
 Doxygen related
 ===============
-.. cmake-module:: ../../doxygen.cmake
+.. cmakemodule:: ../../doxygen.cmake

.docs/pages/internal.rst

@@ -3,26 +3,26 @@ Other commands
 
 Unit-testing
 ============
-.. cmake-module:: ../../test.cmake
-.. cmake-module:: ../../gtest.cmake
+.. cmakemodule:: ../../test.cmake
+.. cmakemodule:: ../../gtest.cmake
 
 Xacro
 =====
-.. cmake-module:: ../../xacro.cmake
+.. cmakemodule:: ../../xacro.cmake
 
 IDL
 ===
-.. cmake-module:: ../../idl.cmake
+.. cmakemodule:: ../../idl.cmake
 
 Version script
 ==============
 
-.. cmake-module:: ../../version-script.cmake
+.. cmakemodule:: ../../version-script.cmake
 
 Cython
 ======
 
-.. cmake-module:: ../../cython/cython.cmake
+.. cmakemodule:: ../../cython/cython.cmake
 
 Make targets
 ============
@@ -33,6 +33,6 @@ The following macros define targets which are added to the Makefile:
 - :ref:`distcheck <target-distcheck>`: checks the generated tarball;
 - :ref:`release <target-release>`: releases a stable version of the current package.
 
-.. cmake-module:: ../../dist.cmake
-.. cmake-module:: ../../distcheck.cmake
-.. cmake-module:: ../../release.cmake
+.. cmakemodule:: ../../dist.cmake
+.. cmakemodule:: ../../distcheck.cmake
+.. cmakemodule:: ../../release.cmake

.docs/pages/other.rst

@@ -9,9 +9,9 @@ These macros are used in packages of the
 
 .. setmode:: hpp
 
-.. cmake-module:: ../../hpp.cmake
+.. cmakemodule:: ../../hpp.cmake
 
-.. cmake-module:: ../../hpp/doc.cmake
+.. cmakemodule:: ../../hpp/doc.cmake
 
 Stack of Tasks
 ==============

.docs/pages/projects.rst

@@ -1,21 +1,6 @@
-# Copyright (C) 2008-2022 LAAS-CNRS, JRL AIST-CNRS, INRIA.
-#
-# This program is free software: you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation, either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# ------ # README # ------ #
-
-# .rst: .. ifmode:: user
+#.rst:
+# Setup the project
+# -----------------
 #
 # This section lists the variables and macros that must be defined and invoked
 # in the right place to enable the features of this cmake modules.
@@ -139,6 +124,23 @@
 # ------
 #
 
+# Copyright (C) 2008-2022 LAAS-CNRS, JRL AIST-CNRS, INRIA.
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# ------ # README # ------ #
+
 if(CMAKE_MINIMUM_REQUIRED_VERSION VERSION_LESS 3.10)
   message(
     FATAL_ERROR

base.cmake

@@ -1,27 +1,6 @@
-# Copyright (C) 2008-2024 LAAS-CNRS, JRL AIST-CNRS, INRIA.
-#
-# This program is free software: you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation, either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program.  If not, see <http://www.gnu.org/licenses/>.
-
-# .rst: .. ifmode:: user
-#
-# .. variable:: ${PROJECT_NAME}_HEADERS
-#
-# List of C++ header filenames. They will be installed automatically using
-# :command:`HEADER_INSTALL`
-#
-
-# .rst: .. ifmode:: internal
+#.rst:
+# C++ Headers
+# -----------
 #
 # .. command:: _SETUP_PROJECT_HEADER
 #
@@ -57,6 +36,30 @@
 # issue. You should at least open a ticket or send an e-mail to notify this
 # behavior.
 #
+
+# Copyright (C) 2008-2024 LAAS-CNRS, JRL AIST-CNRS, INRIA.
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# .rst: .. ifmode:: user
+#
+# .. variable:: ${PROJECT_NAME}_HEADERS
+#
+# List of C++ header filenames. They will be installed automatically using
+# :command:`HEADER_INSTALL`
+#
+
 macro(_SETUP_PROJECT_HEADER)
   # Install project headers.
   if(DEFINED PROJECT_CUSTOM_HEADER_DIR)

header.cmake

@@ -1,3 +1,17 @@
+#.rst:
+# Version
+# -----
+# The version of the project is defined directly from git.
+# If you wish to create a release :
+#.. code-block:: bash
+#
+#  make release VERSION=X.Y.Z
+#
+# The system then tries to create a compressed tar file.
+# It is then build, and install.
+# If this is working a signature is created.
+#
+
 # Copyright (C) 2008-2019 LAAS-CNRS, JRL AIST-CNRS, INRIA.
 #
 # This program is free software: you can redistribute it and/or modify it under