docs: add Sphinx + Read the Docs infrastructure

- Add .readthedocs.yaml build config (Ubuntu 22.04, Python 3.11)
- Add docs/conf.py with myst-parser for Markdown support
- Add docs/index.md toctree including README and existing docs
- Add docs/readme.md to include root README via myst directive
- Add docs/requirements.txt for Sphinx build dependencies
- Add docs/_build/ to .gitignore
This commit is contained in:
Justin Gu
2026-06-08 03:36:40 +08:00
parent 6f7f5bac16
commit 9d906c340c
7 changed files with 73 additions and 4 deletions
+18
View File
@@ -0,0 +1,18 @@
# .readthedocs.yaml
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.11"
sphinx:
configuration: docs/conf.py
formats:
- pdf
- epub
python:
install:
- requirements: docs/requirements.txt