Doc: no automoc for doxygen 1.10

And avoid doxygen 1.10 in conda environments Co-authored-by: Joris Vaillant <joris.vaillant@inria.fr>
nim65s · Jul 12, 2024 · c7c5988 · c7c5988
1 parent eef05b4
commit c7c5988
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/.github/workflows/conda/environment_macos_linux.yml b/.github/workflows/conda/environment_macos_linux.yml
@@ -10,7 +10,7 @@ dependencies:
   - boost
   - eigenpy
   - python
-  - doxygen
+  - doxygen<1.10|>1.11
   - lxml
   - pylatexenc
   - qhull

diff --git a/.github/workflows/conda/environment_windows.yml b/.github/workflows/conda/environment_windows.yml
@@ -10,7 +10,7 @@ dependencies:
   - boost
   - eigenpy
   - python
-  - doxygen
+  - doxygen<1.10|>=1.11
   - lxml
   - pylatexenc
   - qhull

diff --git a/python/CMakeLists.txt b/python/CMakeLists.txt
@@ -61,6 +61,14 @@ IF(    NOT ENABLE_PYTHON_DOXYGEN_AUTODOC
 ELSE()
   SET(ENABLE_DOXYGEN_AUTODOC TRUE)
 
+  IF(DOXYGEN_VERSION VERSION_GREATER_EQUAL 1.10.0 AND DOXYGEN_VERSION VERSION_LESS 1.11.0)
+    # deactivate python doxygen automoc for doxygen 1.10,
+    # as it incorrectly parse "const" keyword,
+    # generating wrong links in C++ doc, and fail generating python doc
+    # ref. https://github.com/doxygen/doxygen/issues/10797
+    SET(ENABLE_DOXYGEN_AUTODOC FALSE)
+    MESSAGE(AUTHOR_WARNING "automoc deactivated because of doxygen 1.10. Please use <1.10 or >=1.11.")
+  ENDIF()
   EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c "import lxml"
     RESULT_VARIABLE _pypkg_found
     OUTPUT_QUIET
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,7 @@ dependencies: @@
       - boost
       - eigenpy
       - python
-      - doxygen
+      - doxygen<1.10|>1.11
       - lxml
       - pylatexenc
       - qhull
@@ Expand Down @@