Documentation¶

Generated projects include a fully configured MkDocs setup with the Material for MkDocs theme.

What's Included¶

• MkDocs Material theme with dark/light mode, search, and navigation features
• mkdocstrings for auto-generated documentation from docstrings
• Code highlighting with copy buttons and annotations
• Admonitions, tabbed content, and other Material extensions

Local Development¶

# Serve docs with live reload (localhost:8080)
make docs-serve

# Check that docs build without errors
make docs-check

# Serve docs with live reload (localhost:8080)
mise run docs:serve

# Check that docs build without errors
mise run docs:check

Deployment¶

# Deploy to GitHub Pages
make docs-deploy

# Deploy to GitHub Pages
mise run docs:deploy

The CI/CD pipeline also deploys docs automatically on pushes to main.

Structure¶

docs/
  index.md          # Landing page
  modules.md        # Auto-generated reference
  css/
    overrides.css   # Custom styling
mkdocs.yml          # MkDocs configuration

Documentation¶

The template uses mkdocstrings with the Python handler to generate docs from your source code docstrings. Simply document your modules and classes with docstrings, and they appear in the docs automatically.