diff --git a/CHANGELOG.md b/CHANGELOG.md index d02b6ed91..32d382746 100644 --- 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 index 6b0564f45..2ede15d1c 160000 --- a/cmake +++ b/cmake @@ -1 +1 @@ -Subproject commit 6b0564f45af29a90160aafdfd67eb7a07ace48ed +Subproject commit 2ede15d1cb9d66401ba96788444ad64c44ffccd8 diff --git a/doc/Doxyfile.extra.in b/doc/Doxyfile.extra.in index d3290a4f1..bbd3d3ae2 100644 --- 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 deleted file mode 100644 index 2ce3915d1..000000000 --- a/doc/additionalDoc/package.hh +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright 2010, - * François Bleibel, - * Olivier Stasse, - * - * CNRS/AIST - * - * This file is part of sot-dynamic. - * sot-dynamic is free software: you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public License - * as published by the Free Software Foundation, either version 3 of - * the License, or (at your option) any later version. - * sot-dynamic 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 Lesser General Public License for more details. You should - * have received a copy of the GNU Lesser General Public License along - * with sot-dynamic. If not, see . - */ - -/** \mainpage -\section soth_section_introduction Introduction - -The soth package is ... - -**/ diff --git a/doc/footer.html b/doc/footer.html deleted file mode 100644 index 535d304e7..000000000 --- a/doc/footer.html +++ /dev/null @@ -1,11 +0,0 @@ -

-
-
- -
soth library documentation
-
-
- - - - diff --git a/doc/header.html b/doc/header.html deleted file mode 100644 index ca3e578a0..000000000 --- a/doc/header.html +++ /dev/null @@ -1,7 +0,0 @@ - - - soth library documentation - - - - diff --git a/doc/package.css b/doc/package.css deleted file mode 100644 index fbc18226a..000000000 --- a/doc/package.css +++ /dev/null @@ -1,230 +0,0 @@ -body { - font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif; - color: #5D5D5D; -} - -dl { - border: 1.5px #82b6d7 solid; - width: 97%; - padding: 5px; - color: #330077; -} - -code { - color: #3C9A35; -} - -td.md { - color: #0066CC; -} - -h1 { - padding-top: 50px; - padding: 0px; - font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif; - font-variant: small-caps; - color:#0066CC; - text-align: center; -} - -h2,h3,hr { - magin-top: 15px; - padding: 0px; - font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif; - font-variant: small-caps; - color:#0066CC; -} - -h4 { - color: #3C9A35; -} - -a:link { - font-weight: bold; - text-decoration: none; - color:#0066CC -} - -a:hover, a:active { - text-decoration: underline; - color: #3C9A35; -} - -a:visited { - font-weight: bold; - color: #3C9A35; - text-decoration: none; -} - -DIV.memitem -{ - spacing: 10px; - width:100%; - background:#FFFFFF; - font-size:100%; - line-height:normal; - border-width: 1px; - border-style: solid; - border-color: #808080; - -moz-border-radius: 8px 8px 8px 8px; -} - -DIV.memproto -{ - width:100%; - background:#F0F0F0; - font-size:100%; - line-height:normal; - border-width: 1px; - border-style: solid; - border-color: #808080; - -moz-border-radius: 8px 8px 8px 8px; -} - -DIV.memdoc -{ - padding: 10px; - width:100%; - font-size:100%; - line-height:normal; -} - -DIV.tabs -{ - float : left; - width : 100%; - background : url("tab_b.gif") repeat-x bottom; - margin-bottom : 4px; -} - -DIV.tabs UL -{ - margin : 0px; - padding-left : 10px; - list-style : none; -} - -DIV.tabs LI, DIV.tabs FORM -{ - display : inline; - margin : 0px; - padding : 0px; -} - -DIV.tabs FORM -{ - float : right; -} - -DIV.tabs A -{ - float : left; - background : url("tab_r.gif") no-repeat right top; - border-bottom : 1px solid #84B0C7; - font-size : x-small; - font-weight : bold; - text-decoration : none; -} - -DIV.tabs A:hover -{ - background-position: 100% -150px; -} - -DIV.tabs A:link, DIV.tabs A:visited, -DIV.tabs A:active, DIV.tabs A:hover -{ - color: #1A419D; -} - -DIV.tabs SPAN -{ - float : left; - display : block; - background : url("tab_l.gif") no-repeat left top; - padding : 5px 9px; - white-space : nowrap; -} - -DIV.tabs INPUT -{ - float : right; - display : inline; - font-size : 1em; -} - -DIV.tabs TD -{ - font-size : x-small; - font-weight : bold; - text-decoration : none; -} - - - -DIV.tabs SPAN {float : none;} - -DIV.tabs A:hover SPAN -{ - background-position: 0% -150px; -} - -DIV.tabs LI#current A -{ - background-position: 100% -150px; - border-width : 0px; -} - -DIV.tabs LI#current SPAN -{ - background-position: 0% -150px; - padding-bottom : 6px; -} - -DIV.nav -{ - background : none; - border : none; - border-bottom : 1px solid #84B0C7; -} - -DIV.groupHeader -{ - padding-top: 30px; - padding-bottom: 20px; - background : none; - border : none; - border-bottom : 1px solid #84B0C7; - font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif; - font-variant: small-caps; - font-size: 14pt; - color:#0066CC; -} - -.directory p -{ - margin: 0px; - white-space: nowrap; - font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif; - font-size: 10pt; - font-weight: normal; -} - - -.directory h3 -{ - font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif; - margin: 0px; - margin-top: 1em; - padding-bottom: 20px; - font-size: 12pt; - font-variant: small-caps; - text-align: center; -} - -.directory a:visited { - font-weight: bold; - text-decoration: none; - color:#0066CC -} - diff --git a/doc/pictures/HRP2.jpg b/doc/pictures/HRP2.jpg deleted file mode 100644 index 377681b20..000000000 Binary files a/doc/pictures/HRP2.jpg and /dev/null differ diff --git a/doc/pictures/footer.jpg b/doc/pictures/footer.jpg deleted file mode 100644 index 377681b20..000000000 Binary files a/doc/pictures/footer.jpg and /dev/null differ diff --git a/doc/pictures/footer.txt b/doc/pictures/footer.txt deleted file mode 100644 index 5c1322c49..000000000 --- a/doc/pictures/footer.txt +++ /dev/null @@ -1,2 +0,0 @@ -Copy in this directory the image you wish to use in the footer of the documentation or edit file sot-core/doc/footer.html and -remove this file. diff --git a/doc/pictures/soth.tif b/doc/pictures/soth.tif deleted file mode 100644 index 3f93b62ae..000000000 Binary files a/doc/pictures/soth.tif and /dev/null differ diff --git a/pixi.toml b/pixi.toml index 0532ddf6a..f10941af5 100644 --- 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", ] }