mkdocs: General DocSite improvements. #400
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #400 +/- ##
=======================================
Coverage 81.26% 81.26%
=======================================
Files 57 57
Lines 7404 7404
=======================================
Hits 6017 6017
Misses 1387 1387 ☔ View full report in Codecov by Sentry. |
spbrogan
approved these changes
Jan 11, 2024
|
Saw Sean's approval come through, missed it earlier. The hierarchical view and dark/light mode support are nice enhancements. |
- Changes the theme to material instead of readthedocs as there are no longer any plans to post this to readthedocs. - Utilizes new features in mkdocs-awesome-pages to allow for a hierarchical sidebar for the API references rather than a flattened list of API references.
Javagedes
force-pushed
the
mkdocs-upgrade
branch
from
84074c7 to
1df859b
Compare
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.
Associated with #392, but will not close until also completed in edk2-pytool-extensions.
Changes the theme to material instead of readthedocs as there are no longer any plans to post this to readthedocs.
Utilizes new features in mkdocs-awesome-pages to allow for a hierarchical sidebar for the API references rather than a flattened list of API references.
Adds light / dark mode to the docs
Adds navigation tabs in the header for the main links.
Sidebar changes
Before
After