# Starlight Pydocs

> starlight-pydocs generates Python API reference documentation for Astro and Starlight sites. It extracts the API surface with Griffe and renders it with Astro components on injected routes.

Notes for reading this documentation:

- The plugin is the Starlight counterpart of mkdocstrings-python and follows its conventions: the same heading anchor scheme, the same member filtering rules, and `::: name` becomes `<Autodoc name="…" />`.
- Extraction is static. Griffe never imports the documented package, so no runtime dependency of that package has to be installable.
- A site can skip Python entirely by pointing the plugin at a pre-generated `griffe dump` JSON file.

## Documentation Sets

- [Abridged documentation](https://ewels.github.io/starlight-pydocs/llms-small.txt): a compact version of the documentation for Starlight Pydocs, with non-essential content removed
- [Complete documentation](https://ewels.github.io/starlight-pydocs/llms-full.txt): the full documentation for Starlight Pydocs

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [demopkg API reference (Markdown)](https://ewels.github.io/starlight-pydocs/api/demopkg/llms.txt): The example package, rendered by this site: google-style docstrings, pydantic models, deprecations, inheritance and `__all__` filtering.
- [numpkg API reference (Markdown)](https://ewels.github.io/starlight-pydocs/api/numpkg/llms.txt): The same output for a package documented with numpy-style docstrings.
- [sphpkg API reference (Markdown)](https://ewels.github.io/starlight-pydocs/api/sphpkg/llms.txt): The same output for sphinx-style docstrings, built from a pre-generated dump with no Python involved.