Reference

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

Generated from the internal agentic facade; names and paths change at the Shepherd rename.

The everyday surface is the top-level facade:

import shepherd as shp
from shepherd.providers import claude

What's here

• Per-symbol API pages (api/) — one page per public facade symbol, rendered from the real source docstrings at build time and listed in the reviewer build's navigation. A committed snapshot (_generated/python-api/public-symbols.json) records name, source, kind, signature, and a docstring hash per symbol; CI fails on drift.
• CLI — generated from a checked fixture (simulated --help capture) until the CLI ships.
• Source-state inventory — the ledger of what these docs may claim today.

How generation stays honest

Symbols enter this reference by being exported from the facade's __all__ — never by merely being importable. Pages are regenerated by ./1_generate_docs_from_frozen_code.sh; hand-edits are clobbered by design.