Clean up default rosdoc2.yaml to show all available options, but commented out. #138
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.