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

Clean up default rosdoc2.yaml to show all available options, but commented out. #138

Merged
merged 5 commits into from
Jul 31, 2024

Conversation

rkent
Copy link
Contributor

@rkent rkent commented Jul 26, 2024

Best practice IMHO in a default configuration file should be to show all available options without requiring consulting documentation or source code, with the options showing default values but commented out. That way a user can easily modify the default file by uncommenting and changing a single option. It is then clear what was changed.

This PR cleans up the default rosdoc2.yaml file according to those principles. It is done in a series of changes that could be reviewed separately, but they are all related by a single goal.

The changes are:

  • remove the unused generate_package_index
  • comment out "settings" section options
  • comment out "builders" section options
  • add any missing options
  • add a test that re-enable the commented out sections to show that the defaults really do work.

The test is just a copy of the full_package tests, but with a default rosdoc2.yaml with defaults uncommented out. The test has one uncommented item, sphinx_sourcedir. This cannot be uncommented until #137 is fixed.

This PR is motivated by cleaning up some of the configuration in preparation to a more complete documentation of the customization options.

@rkent rkent requested review from audrow and tfoote as code owners July 26, 2024 18:00
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 this cleanup. It's definitely going to provide a better user experience.

@tfoote tfoote merged commit 9b7b77a into ros-infrastructure:main Jul 31, 2024
5 checks passed
@rkent rkent deleted the test-default-rosdoc2-yaml branch August 3, 2024 04:09
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