From 9585320d5076a3f708d8cfb016bbd192b077c156 Mon Sep 17 00:00:00 2001 From: Jonas Otto Date: Sat, 17 Feb 2024 13:16:15 +0100 Subject: [PATCH] add information about wrapping sphinx conf.py to README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 873bd6a..10d5b77 100644 --- a/README.md +++ b/README.md @@ -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: