Complete rewrite of documentation, moving from Sphinx to mkdocs #266
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.
Drops Sphinx in favour of mkdocs for generating the documentation. Needs
mkdocs
,mkdocs-material
,mkdocstrings
andmkdocstrings-python
packages for generation.The documentation itself also has seen a major overhaul:
.pyi
type files, which makes it easier to read and edit.mkdocstrings
is also much better in generating docs from the Python type files than from the docstrings generated by pybind11.