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)
46 lines
1 KiB
Python
46 lines
1 KiB
Python
"""Sphinx configuration for Aborist API reference."""
|
|
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
# Add aborist package to path
|
|
project_root = Path(__file__).parent.parent.parent
|
|
sys.path.insert(0, str(project_root))
|
|
|
|
# Project info
|
|
project = "Aborist"
|
|
copyright = "2026, agent blackops"
|
|
author = "fox/timehexon"
|
|
version = "9.8"
|
|
release = "9.8.0"
|
|
|
|
# Extensions
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.viewcode",
|
|
]
|
|
|
|
# Autodoc settings
|
|
autodoc_member_order = "bysource"
|
|
autodoc_typehints = "description"
|
|
autodoc_typehints_format = "short"
|
|
|
|
# Napoleon (Google/NumPy docstring) settings
|
|
napoleon_google_docstring = False
|
|
napoleon_numpy_docstring = True
|
|
napoleon_attr_annotations = True
|
|
|
|
# HTML output
|
|
html_theme = "furo"
|
|
html_static_path = ["_static"]
|
|
html_title = "Aborist API Reference"
|
|
|
|
# Suppress warnings for missing references
|
|
suppress_warnings = ["ref.doc"]
|
|
|
|
# Intersphinx mapping (for external doc links)
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
}
|