AthenaK documentation

User-facing documentation for AthenaK, built with the help of AI using Sphinx and the Furo theme. This site is intended to replace the project's GitHub wiki.

The published site is hosted on GitHub Pages: https://ias-astrophysics.github.io/athenak-docs/.

Building locally

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

sphinx-build -b html source build/html

Then open build/html/index.html in a browser. Alternatively, use make html.

Continuous integration

The Docs workflow runs on every push and pull request:

• Build (strict): builds the site with sphinx-build -W --keep-going, so any Sphinx warning fails the check and broken docs cannot be merged.
• Deploy: on main, the built site is published to GitHub Pages.