docs: sphinx reference doc index generation #853
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To be able to list the whole policy reference definition, we needs index file for each category. Create them on the fly, listing the reference policies generated in the reference destination directory, before generating the finale documentation. Co-authored-by: Jean-Baptiste Lallement <jean-baptiste@ubuntu.com>
With make run, listening to any file changes in the destination directory, the script generating the index files will rerun everytime, creating a new event, rerunning the generation and so on. Exclude then any index files under those known subdirectories.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #853 +/- ##
=======================================
Coverage 86.10% 86.10%
=======================================
Files 76 76
Lines 8599 8599
=======================================
Hits 7404 7404
Misses 866 866
Partials 329 329 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Run a pre-hook to create index file in policy reference.
To be able to list the whole policy reference definition, we needs index file for each category.
Create them on the fly, listing the reference policies generated in the reference destination directory, before generating the finale documentation.
UDENG-1450