Merge pull request #533 from jorisv/topic/update-jrlcmake

Mordernize doxygen
stack-of-tasks · Feb 11, 2025 · 14d2658 · 14d2658
2 parents a36450c + bc30f29
commit 14d2658
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 284 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Added
+- Add `BUILDING_ROS2_PACKAGE` to generate ament specific file ([#530](https://github.com/stack-of-tasks/eigenpy/pull/530))
+
+### Changed
+- Modernize doxygen documentation ([#533](https://github.com/stack-of-tasks/eigenpy/pull/533))
+
 ## [3.10.2] - 2025-01-13
 
 ### Fixed

diff --git a/cmake b/cmake
diff --git a/doc/Doxyfile.extra.in b/doc/Doxyfile.extra.in
@@ -1,7 +1,34 @@
-INPUT                  = @PROJECT_SOURCE_DIR@/src \
-                         @PROJECT_SOURCE_DIR@/doc/additionalDoc
-IMAGE_PATH             = @PROJECT_SOURCE_DIR@/doc/pictures
+INPUT                 = @PROJECT_SOURCE_DIR@/doc \
+                        @PROJECT_SOURCE_DIR@/include \
+                        @PROJECT_SOURCE_DIR@/README.md
 
-FILE_PATTERNS          = *.cc *.cpp *.h *.hpp *.hxx
+RECURSIVE               = YES
 
-TAGFILES               = \
+FILE_PATTERNS          = *.cpp *.h *.hpp *.hxx
+
+EXTRACT_ALL             = NO
+EXTRACT_ANON_NSPACES    = NO
+
+ENABLE_PREPROCESSING    = YES
+MACRO_EXPANSION         = YES
+
+FULL_PATH_NAMES         = YES
+EXCLUDE_SYMBOLS         = std, *::internal, internal::*, *::internal::*
+
+INCLUDE_PATH            = @PROJECT_SOURCE_DIR@/include
+
+GENERATE_TREEVIEW       = YES
+
+VERBATIM_HEADERS        = YES
+
+SHOW_FILES              = YES
+SHOW_NAMESPACES         = YES
+
+SOURCE_BROWSER          = YES
+
+ALPHABETICAL_INDEX      = YES
+
+USE_MDFILE_AS_MAINPAGE  = README.md
+BUILTIN_STL_SUPPORT     = YES
+HAVE_DOT                = YES
+DOT_IMAGE_FORMAT        = SVG
diff --git a/doc/additionalDoc/package.hh b/doc/additionalDoc/package.hh
diff --git a/doc/footer.html b/doc/footer.html
diff --git a/doc/header.html b/doc/header.html
diff --git a/doc/package.css b/doc/package.css
diff --git a/doc/pictures/HRP2.jpg b/doc/pictures/HRP2.jpg
diff --git a/doc/pictures/footer.jpg b/doc/pictures/footer.jpg
diff --git a/doc/pictures/footer.txt b/doc/pictures/footer.txt
diff --git a/doc/pictures/soth.tif b/doc/pictures/soth.tif
diff --git a/pixi.toml b/pixi.toml
@@ -47,9 +47,9 @@ configure = { cmd = [
   "-DBUILD_WITH_CHOLMOD_SUPPORT=$EIGENPY_CHOLMOD_SUPPORT",
   "-DBUILD_WITH_ACCELERATE_SUPPORT=$EIGENPY_ACCELERATE_SUPPORT",
 ] }
-build = { cmd = "cmake --build build --target all", depends_on = ["configure"] }
+build = { cmd = "cmake --build build --target all", depends-on = ["configure"] }
 clean = { cmd = "rm -rf build" }
-test = { cmd = "ctest --test-dir build --output-on-failure", depends_on = [
+test = { cmd = "ctest --test-dir build --output-on-failure", depends-on = [
   "build",
 ] }