Skip to content

Add AGENTS.md with repo structure and build guidance #857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
drbenvincent wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add AGENTS.md with repo structure and build guidance #857

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# AGENTS.md

## Repository structure

- `.ipynb` is the source of truth. A pre-commit jupytext hook auto-generates `.myst.md` from `.ipynb` — edit only the `.ipynb`.
- Only `.ipynb` files are used by Sphinx; `.myst.md` is excluded via `exclude_patterns` in `examples/conf.py`.
- `requirements-docs.txt` lists Sphinx/theme dependencies for the ReadTheDocs build only.
- `sphinxext/thumbnail_extractor.py` is a custom Sphinx extension that extracts thumbnail images from notebook outputs.

## Do not commit

- Agent-generated artifacts, scratch notes, or temporary files (e.g. `.github/pr-summaries/`, draft summaries).

## ReadTheDocs (remote) builds

- `nb_execution_mode = "off"` in `examples/conf.py` — notebooks are never executed during RTD builds. Missing Python packages (pymc, arviz, etc.) cannot cause RTD failures.
- RTD "Unknown problem" failures with short duration (~140s vs normal ~350s) are transient infrastructure/pip-install failures. Retrigger with an empty commit or from the RTD dashboard before investigating further.