Skip to content

Commit

Permalink
add information about wrapping sphinx conf.py to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@ottojo
ottojo committed Feb 17, 2024
1 parent eca80c6 commit 9585320
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,9 @@ The Sphinx builder will attempt to do a few things to ensure it runs even withou

The final default is in place, even for packages with only C++, so that we can enable cross-referencing between packages using Sphinx and Breathe.

If an existing sphinx project is found, the `conf.py` sphinx configuration will be extended to enable rosdoc2-specific features according to the rosdoc2 configuration.
Additionally, the `project`, `author`, `release` and `version` options are populated from package.xml if they are not specified in `conf.py`.

#### Doxygen Builder

The Doxygen builder will attempt to run even with no additional configuration, following these steps:
Expand Down

0 comments on commit 9585320

Please sign in to comment.