Python API

Page status: scaffold Source state: generated Applies to: Shepherd v1.0-dev Owner: @docs-system-owner (TBD) Validation: scripts/gen_shepherd_api_inventory.py --check

This is reference — exact, generated facts. The mental model lives in concepts; recipes live in guides.

Pre-rename surface — scaffolded entry

This is the curated entry page for the Python API reference (P-030 §"Generated API Reference"). The per-symbol facts are generated from the public facade into reference/api/ and verified against docs/_generated/shepherd/python-api/public-symbols.json. Names render from the internal agentic facade until the Shepherd rename; this page becomes release-ready when the facade is renamed and the symbols are documented to the public bar.

Shepherd's public surface is a small facade: you import shepherd as shp and reach the task/workspace/delivery spine plus the effect and run vocabulary. The generator targets only the accepted public facade — internal implementation packages are never swept into this reference just because they are importable.

The exact, generated per-symbol pages live under reference/api/ — one page per public symbol, regenerated and drift-checked on every build (see task for the shape). The machine-readable inventory is docs/_generated/shepherd/python-api/public-symbols.json.