The docs overhaul PR has finally arrived.

Features

• Sphinx has been replaced with mkdocs, which from my experiences have been much easier to work with
• Uses markdown instead of RST, so all docs files have been formatted for MD
• Fixed many formatting errors and enhanced others, such as note and warning blocks
• API autogenerated like before
• Workflow triggers on new release to build the docs and publish to the gh-pages branch, where github will host it from
• Tutorials link will redirect users to the tutorials docs website, which will maintain the same sidebar to redirect back enabling a seamless transition
• Since MD supports HTML, we can further enhance our docs with custom implementations as needed
• Organized the docs files into subdirectories that match the mkdocs nav
• Rewrote the profiling docs with modern testing

And finally, more deletions than additions.

Building docs is pretty easy:

$ uv sync --optional docs
$ uv run mkdocs serve

Serve will build but not save, if you want a locally built copy saved:

$ uv run mkdocs build
$ uv run -m http.server -d site 8000 # Create a webserver to host the newly built site/ directory

If not using uv:

$ pip install -e ".[docs]"
$ mkdocs serve

Screenshots

Simplified the sidebar:

Info & warning blockquotes:

New testing documentation: