mystmd-pythonapi

How to run and extend this repo's acceptance test suite. Use when adding or modifying tests, verifying a change end-to-end, or when ./run_all.sh fails. Covers the oracle contract, the offline test harness (serve a local inventory + the myst build --all export oracle), and how to add a new acceptance test.

The load-bearing mystmd v1.10.1 facts and design invariants that keep this project's API cross-references case-sensitive (re.match ≠ re.Match). READ THIS BEFORE modifying anything under src/ (the plugin, inventory writer, {py} role, {apidoc} directive), python/ (extractor), or any objects.inv / anchor logic. Warns about the $-anchor lowercasing foot-gun and the other collapse traps that silently break case-sensitivity.

Bootstrap the Node/mystmd + Python (griffe/sphinx/sphobjinv) toolchain for this repo. Use when npm/npx/myst/python are missing, when builds or tests fail with "command not found", or when setting up a fresh dev container. Covers the read-only-rootfs and zsh-no-rc gotchas specific to the sandbox this project was built in.