docs(theme): upgrade mkdocs material to 8.x #534
Merged
Conversation
This file contains hidden or 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
dreamorosi
added
documentation
ijemmy
reviewed
Feb 11, 2022
.gitignore
Outdated
| @@ -36,6 +36,7 @@ venv | |||
|
|
|||
| # Static documentation site generated by Mkdocs | |||
| site | |||
| !docs/overrides/*.html | |||
There was a problem hiding this comment.
Why do we need an override to be included in git. Is it being ignored somewhere else?
There was a problem hiding this comment.
If it really needs to be in this file, a comment would be useful for future contributors.
There was a problem hiding this comment.
Good catch, remove it in the latest commit.
ijemmy
approved these changes
Feb 14, 2022
flochaz
approved these changes
Feb 15, 2022
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.
Description of your changes
This PR updates MKDocs (the documentation engine we use) and adds the necessary extension to add annotations on code (no annotation added at this time). The PR mirrors this commit from the Python's repo.
How to verify this change
Checkout repo & build docs locally.
Related issues, RFCs
N/A
PR status
Is this ready for review?: NO
Is it a breaking change?: NO
Checklist
Breaking change checklist
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.