Documentation

More Documentation pages

Everything else tagged documentation, grouped by section. Pages featured above are not repeated here.

How To

How to Build Read the Docs with uv

Configure Read the Docs to install dependencies with uv. Use dependency groups and lockfiles for reproducible builds.

How to Set Up Documentation for a Python Package with Sphinx or MkDocs

Choose Sphinx or MkDocs, scaffold docs, pull docstrings via autodoc/mkdocstrings, preview locally, deploy to Read the Docs.

Reference

Furo

Furo is a clean, customisable Sphinx theme with built-in light and dark modes, used by pip, attrs, and many smaller Python projects.

Material for MkDocs

Material Design MkDocs theme with search, dark mode, code annotations, social cards. Used by FastAPI, Pydantic, Typer, and hundreds of Python projects.

MkDocs

MkDocs is a static site generator that builds project documentation from Markdown source files and a single YAML configuration file.

mkdocstrings

mkdocstrings is a MkDocs plugin that injects API documentation generated from source code (Python, C, TypeScript, and more) into Markdown pages.

Read the Docs

Hosted documentation platform that automatically builds and serves Python docs from Git. Supports Sphinx, MkDocs, Docusaurus. Free for open source.

sphinx-autobuild

sphinx-autobuild watches a Sphinx documentation source tree and rebuilds the HTML on every change, refreshing the browser automatically.

Sphinx

Sphinx: documentation generator for reStructuredText or Markdown. Powers Python docs, NumPy, SciPy. Supports HTML, PDF, ePub, autodoc.