Skip to content
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.

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

add more default configuration to sphinx conf.py #60

Merged
merged 3 commits into from
Feb 27, 2024

Conversation

ottojo
Copy link
Contributor

@ottojo ottojo commented Feb 16, 2024

Add values extracted from package.xml to the wrapping sphinx config.py. This eliminates the need for packages with custom config.py to duplicate author, copyright and version information from package.xml.

A more comprehensive proposal was made in #42, but this part (keeping package.xml and config.py in sync) was what i came across today, and what is solvable a lot easier...

@ottojo ottojo requested review from audrow and tfoote as code owners February 16, 2024 22:19
Copy link
Member

@tfoote tfoote left a comment

Choose a reason for hiding this comment

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

Thanks extending it this way will help get more visibility. I'd like to pull back the copyright info though as omitting it is better than giving partial info.

rosdoc2/verbs/build/builders/sphinx_builder.py Outdated Show resolved Hide resolved
Add values extracted from package.xml to the wrapping sphinx config.py. This eliminates the need for packages with custom config.py to duplicate author, copyright and version information from package.xml.
@ottojo ottojo force-pushed the sphinx_conf_from_package_xml branch from 225c6c3 to eca80c6 Compare February 17, 2024 12:03
Copy link
Member

@tfoote tfoote left a comment

Choose a reason for hiding this comment

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

Thanks for the revision. One more tweak to make the output repeatable and more readable.

rosdoc2/verbs/build/builders/sphinx_builder.py Outdated Show resolved Hide resolved
rosdoc2/verbs/build/builders/sphinx_builder.py Outdated Show resolved Hide resolved
Co-authored-by: Tully Foote <[email protected]>
@ottojo ottojo requested a review from tfoote February 25, 2024 09:45
@tfoote tfoote merged commit 97b3be2 into ros-infrastructure:main Feb 27, 2024
2 checks passed
@ottojo ottojo deleted the sphinx_conf_from_package_xml branch February 27, 2024 19:20
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.

2 participants