russell@unturf.com
8e9e993571
Add .readthedocs.yaml at project root so docs.aborist (or aborist.readthedocs.io) can build the Sphinx API reference on push. Configuration: - Ubuntu 24.04, Python 3.13 - Sphinx config: docs/_source/conf.py - Build deps: docs/_source/requirements.txt (sphinx, furo) - Install package with [html, wikitext] extras so autodoc imports succeed Cleanup: - Untrack docs/_source/_build/ (generated artifact, RTD builds on push) - Add _build/ to .gitignore - Create docs/_source/_static/ placeholder (Sphinx convention) - Remove non-functional html_sidebars override from conf.py (furo defaults are better; build now produces 0 warnings vs 29)
21 lines
387 B
YAML
21 lines
387 B
YAML
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
version: 2
|
|
|
|
build:
|
|
os: ubuntu-24.04
|
|
tools:
|
|
python: "3.13"
|
|
|
|
sphinx:
|
|
configuration: docs/_source/conf.py
|
|
|
|
python:
|
|
install:
|
|
- requirements: docs/_source/requirements.txt
|
|
- method: pip
|
|
path: .
|
|
extra_requirements:
|
|
- html
|
|
- wikitext
|