Hosting on Read the Docs¶

This documentation pack includes:

.readthedocs.yaml
docs/requirements.txt
docs/source/conf.py
docs/source/index.rst

Setup steps¶

Copy the files from this pack into your project root.
Commit and push to GitHub.
Create or import the project on Read the Docs.
Make sure the default branch contains .readthedocs.yaml.
Trigger a build.

Local build¶

pip install -e .
pip install -r docs/requirements.txt
cd docs
make html

Read the Docs config¶

The included config uses Read the Docs v2 configuration:

version: 2

build:
  os: ubuntu-24.04
  tools:
    python: "3.11"

sphinx:
  configuration: docs/source/conf.py

python:
  install:
    - requirements: docs/requirements.txt
    - method: pip
      path: .