Migrate documentation to mkdocs + various improvements#116
Merged
Conversation
Contributor
|
Things you love to see:
|
thomaszwagerman
approved these changes
Jan 28, 2026
Contributor
thomaszwagerman
left a comment
There was a problem hiding this comment.
Looks great. Quite a few warnings from griffe, but as you say, we can tackle those and they aren't necessarily to do with the docs themselves, rather the docstrings.
8a99417 to
6cfbe76
Compare
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
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.
Resolves #112
There's still a fair bit to do here:
Note: Merge target is set to
github-pages-docsfor now to keep the diff relevant, but we should really get that branch merged soon and this can target main instead.