migrate docs from Sphinx/RST to MkDocs Material #1503
Draft
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
- replace Sphinx with MkDocs + Material theme - use mkdocstrings for API docs from NumPy docstrings - convert 73 RST files to Markdown - remove RST directives from Python docstrings - update CI workflow for mkdocs gh-deploy - update invoke tasks for mkdocs commands
Replaces Sphinx with MkDocs, adopting the Material theme for documentation. Updates CI workflows and invoke tasks for MkDocs commands. Converts 73 RST files to Markdown and removes RST directives from Python docstrings. Enhances API documentation using mkdocstrings to parse NumPy-style docstrings.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Test plan
mkdocs serveworks locallymkdocs build --strictpasses