Add repository README.md to generate_parameter_library package docs #296
+15
−1
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.
This makes the README.md appear on the package docs landing page of generate_parameter_library.
rosdoc2 automatically includes a README.md on the package docs landing page (https://docs.ros.org/en/kilted/p/generate_parameter_library/index.html), but the readme is one level up at the repo root in this repository.
Including it in a custom index.rst does not work easily, since rosdoc2 does some wrapping of the package directory, and does not build the docs in-tree. But symlinks seem to work just fine (the link gets resolved when copying standard doc files to the "wrapped" directory). There are certainly ways to improve this (adding the sections to the TOC on the left, for example), but i think this is a good first improvement.
fixes #285
Screenshots: