The rendered documentation is built with Sphinx (MyST Markdown) and hosted on ReadTheDocs. This folder is the source.
Build it locally:
pip install -e ".[excel,plotting]"
pip install -r docs/requirements.txt
sphinx-build -b html docs docs/_build/html
# open docs/_build/html/index.html| Path | Contents |
|---|---|
index.md |
Landing page + master table of contents |
installation.md |
Install, extras, solvers, external binaries |
guide/ |
Task-oriented user guide (one page per capability) |
reference/ |
Migration map, back-port proposals, improvements, and the autogenerated API reference |
studies/ |
Empirical validation & parameter-calibration studies |
maintenance/ |
Data-bundle formats and release/maintenance procedures |
archive/ |
Historical design notes (pre-implementation reviews) |
The top-level CHANGELOG.md and IMPROVEMENTS.md are
included into the site under Project and Reference respectively.