Skip to content

[doc] Revamp/modernize visual look of documentation, update Doxygen config options #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ManifoldFR merged 9 commits into from
Jun 4, 2025
Merged

[doc] Revamp/modernize visual look of documentation, update Doxygen config options #7

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ccf60e6
readme : update affiliations
ManifoldFR Jun 4, 2025
451016b
doc/Doxyfile : update predefined macros
ManifoldFR Jun 4, 2025
7915016
doc/Doxyfile : remove obsolete option COLS_IN_ALPHA_INDEX
ManifoldFR Jun 4, 2025
bb9f0f6
doc/Doxyfile : update excluded symbols.
ManifoldFR Jun 4, 2025
4964432
Update CHANGELOG
ManifoldFR Jun 4, 2025
d52055f
Use doxygen-awesome
ManifoldFR Jun 4, 2025
33f8064
algorithm/utils : remove wrong use of Doxygen `\example` command
ManifoldFR Jun 4, 2025
706edcf
algorithm/utils : some doc cleanup
ManifoldFR Jun 4, 2025
bf8ce07
Remove outline.txt
ManifoldFR Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ The currently active core developers of **Pinocchio** are:
- [Justin Carpentier](https://jcarpent.github.io) (Inria): main developer and manager of the project
- [Guilhem Saurel](https://www.laas.fr/fr/annuaire/gsaurel) (LAAS-CNRS): CI/CD, packaging
- [Etienne Arlaud](https://github.com/EtienneAr) (Inria): core developer
- [Wilson Jallet](https://github.com/ManifoldFR) (LAAS-CNRS/Inria): extension of Python bindings, C++ visualization API
- [Wilson Jallet](https://github.com/ManifoldFR) (Inria): extension of Python bindings, C++ visualization API
- [Fabian Schramm](https://github.com/fabinsch) (Inria): core developper
- [Stéphane Caron](https://scaron.info) (Inria): core developper
- [Joris Vaillant](https://github.com/jorisv) (Inria): core developer and project manager
Expand Down
16 changes: 8 additions & 8 deletions doc/Doxyfile.extra.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,12 @@ EXCLUDE_PATTERNS += CMake* \
# AClass::ANamespace, ANamespace::*Test

EXCLUDE_SYMBOLS = internal::* \
*Visitor
detail*::* \
*Visitor \
boost::* \
Eigen::* \
eigenpy::* \
std::*

# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
Expand Down Expand Up @@ -397,12 +402,6 @@ VERBATIM_HEADERS = YES

ALPHABETICAL_INDEX = YES

# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# in which this list will be split (can be a number in the range [1..20])

COLS_IN_ALPHA_INDEX = 4

#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
Expand Down Expand Up @@ -608,7 +607,8 @@ PREDEFINED += EIGEN_MAKE_ALIGNED_OPERATOR_NEW \
PINOCCHIO_WITH_URDFDOM \
PINOCCHIO_WITH_CPPAD_SUPPORT \
PINOCCHIO_WITH_CPPADCG_SUPPORT \
PINOCCHIO_WITH_LUA5
PINOCCHIO_DONT_INLINE \
PINOCCHIO_NOEXCEPT=noexcept

# The following macros would be better treated with EXPAND_AS_DEFINED.
# However, it was not working properly
Expand Down