-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate documentation to use Markdown and MkDocs (#1397)
Migrate documentation to use [MkDocs](https://www.mkdocs.org/) with the [Material Theme](https://squidfunk.github.io/mkdocs-material/) for the build. Replaced all use of reStructuredText with Markdown and all use of Sphinx with MkDocs. TODO: - [x] Create MkDocs Material theme basic setup and configuration - [x] Translate reStructuredText docs to Markdown using `pandoc` - [x] Verify MkDocs build and serve are working - [x] Delete Sphinx stuff and make sure GitHub Actions doc build is working - [x] Finish correcting basic translation errors - [x] Get automated API documentation using [mkdocstrings](https://mkdocstrings.github.io/) working nicely - [x] Figure out how to do autodoc references using `mkdocstring` - [x] Final cleanup check of markdown - [x] Make [recommended tweaks](https://docs.readthedocs.io/en/stable/intro/mkdocs.html) for hosting docs on ReadTheDocs - [x] Add example of using [mermaid](https://mermaid.js.org/) to embed diagrams in `scripting.md` - [x] Verify ReadTheDocs build is working properly Closes #1396
- Loading branch information
1 parent
91fd9b1
commit 9d3f227
Showing
150 changed files
with
4,704 additions
and
7,221 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
# Python development, test, and build | ||
__pycache__ | ||
target | ||
build | ||
dist | ||
*.egg-info | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Markdown documentation files with non-standards syntax for mkdocstrings that Prettier should not auto-format | ||
docs/features/initialization.md |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
{ | ||
"overrides": [ | ||
{ | ||
"files": "*.md", | ||
"options": { | ||
"tabWidth": 4 | ||
} | ||
} | ||
] | ||
} |
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
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
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
Oops, something went wrong.