Skip to content

Conversation

@ManifoldFR
Copy link
Member

@ManifoldFR ManifoldFR commented Jun 4, 2025

Doc visual style update

We now use doxygen-awesome-css.

We now have to set HTML_COLORSTYLE.

Doxyfile config updates

Update predefined macros

Fix obsolete options:

  • COLS_IN_ALPHA_INDEX

Exclude symbols:

  • boost::
  • std::
  • Eigen::
  • eigenpy::
  • detail*::

Comparison

Before

Overview

Screenshot From 2025-06-04 17-23-58

Namespace list (notice the extraneous namespaces here)

Screenshot From 2025-06-04 17-26-51

After

Overview

Screenshot From 2025-06-04 17-23-55

Namespace list (cleaned out through doxygen options & updating HTML header)

Screenshot From 2025-06-04 17-41-44

Side-by-side

Left: after Right: before

image

Notes

  • There is now a dark-mode toggle button (from doxygen-awesome) in the top-right corner. The default light/dark theme depends on your browser settings.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Hi,
This is a reminder message to assign an extra build label to this Pull Request if needed.
By default, this PR will be build with minimal build options (URDF support and Python bindings)
The possible extra labels are:

  • build_collision (build Pinocchio with coal support)
  • build_casadi (build Pinocchio with CasADi support)
  • build_autodiff (build Pinocchio with CppAD support)
  • build_codegen (build Pinocchio with CppADCodeGen support)
  • build_extra (build Pinocchio with extra algorithms)
  • build_mpfr (build Pinocchio with Boost.Multiprecision support)
  • build_sdf (build Pinocchio with SDF parser)
  • build_accelerate (build Pinocchio with APPLE Accelerate framework support)
  • build_all (build Pinocchio with ALL the options stated above)

Thanks.
The Pinocchio development team.

@ManifoldFR ManifoldFR changed the title Topic/new look docs Revamp visual look of documentation with doxygen-awesome-css, update Doxygen config options Jun 4, 2025
@ManifoldFR ManifoldFR force-pushed the topic/new-look-docs branch from ed2f9e7 to 47d97e8 Compare June 4, 2025 15:38
+ update doc/header.html
+ add dark/light mode toggle
@ManifoldFR ManifoldFR marked this pull request as ready for review June 4, 2025 15:48
@ManifoldFR ManifoldFR changed the title Revamp visual look of documentation with doxygen-awesome-css, update Doxygen config options [doc] Revamp/modernize visual look of documentation, update Doxygen config options Jun 4, 2025
@ManifoldFR ManifoldFR force-pushed the topic/new-look-docs branch from 47d97e8 to d52055f Compare June 4, 2025 15:50
@ManifoldFR ManifoldFR force-pushed the topic/new-look-docs branch from e3f409d to 706edcf Compare June 4, 2025 16:28
@ManifoldFR ManifoldFR merged commit e1f70a6 into pin4 Jun 4, 2025
0 of 3 checks passed
@ManifoldFR ManifoldFR deleted the topic/new-look-docs branch June 4, 2025 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants