Support "awesome-pages" #1242
Closed
Support "awesome-pages" #1242
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
hakuturu583
added
the
bump patch
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.
Abstract
Adding the
awesome-pagesplugin to the documentation build enhances the development experience.Background
Writing the entire configuration of pages in
mkdocs.yamlrequires writing cumbersome paths when adding files, and it becomes unreadable when consolidated into one file.Details
Added the
awesome-pagesplugin and added a.pagesfile in thedocsubdirectory. This allows specifying a distributed document structure. Added a dependency to the pyproject to use theawesome-pagesplugin.References
This plugin is used in the Autoware documentation, and I referenced its usage.
https://github.com/autowarefoundation/autoware-documentation
Destructive Changes
N/A
Known Limitations
N/A