# gp-sphinx
> Integrated autodoc design system for git-pull Sphinx projects.
## Documentation
- [What’s new](https://gp-sphinx.git-pull.com/whats-new/): The autodoc-improvements branch introduces a unified autodoc design system — eight major advancements that transform how the documentation stack works. See the gallery for a visual showcase.
- [Gallery](https://gp-sphinx.git-pull.com/gallery/): Every example on this page is rendered live from the same extensions and theme your project gets out of the box. Nothing is mocked — the output below is the real autodoc pipeline.
- [Architecture](https://gp-sphinx.git-pull.com/architecture/): Workspace packages organized in tiers. Lower layers never depend on higher ones — autodoc extensions consume shared infrastructure, and the presentation layer wires everything together for downstr...
- [Quickstart](https://gp-sphinx.git-pull.com/quickstart/): For latest official version:
- [Configuration](https://gp-sphinx.git-pull.com/configuration/): Reference for gp_sphinx.config.merge_sphinx_config() and the shared defaults it applies.
- [Packages](https://gp-sphinx.git-pull.com/packages/): The workspace ships independently-installable Sphinx packages organized by family. Each package has its own page; the grid below auto-enumerates the full set as the workspace evolves.
- [API Reference](https://gp-sphinx.git-pull.com/api/): Public API for building Sphinx configurations and source link resolvers.
- [Project](https://gp-sphinx.git-pull.com/project/): Information for contributors and maintainers.
- [Changelog](https://gp-sphinx.git-pull.com/history/): To install the unreleased gp-sphinx version, see developmental releases.
## Autodoc
- [sphinx-autodoc-api-style](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-api-style/): Alpha GitHub PyPI
- [sphinx-autodoc-argparse](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-argparse/): Alpha GitHub PyPI
- [sphinx-autodoc-docutils](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-docutils/): Alpha GitHub PyPI
- [sphinx-autodoc-fastmcp](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-fastmcp/): Alpha GitHub PyPI
- [sphinx-autodoc-pytest-fixtures](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-pytest-fixtures/): Alpha GitHub PyPI
- [sphinx-autodoc-sphinx](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-sphinx/): Alpha GitHub PyPI
- [sphinx-autodoc-typehints-gp](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-typehints-gp/): Alpha GitHub PyPI
## UX
- [sphinx-ux-autodoc-layout](https://gp-sphinx.git-pull.com/packages/sphinx-ux-autodoc-layout/): Alpha GitHub PyPI
- [sphinx-ux-badges](https://gp-sphinx.git-pull.com/packages/sphinx-ux-badges/): Alpha GitHub PyPI
## Tokens
- [@gp-sphinx/furo-tokens](https://gp-sphinx.git-pull.com/packages/@gp-sphinx/furo-tokens/): Unknown GitHub npm
- [sphinx-fonts](https://gp-sphinx.git-pull.com/packages/sphinx-fonts/): Alpha GitHub PyPI
## Theme & coordinator
- [gp-furo-theme](https://gp-sphinx.git-pull.com/packages/gp-furo-theme/): Alpha GitHub PyPI
- [gp-sphinx](https://gp-sphinx.git-pull.com/packages/gp-sphinx/): Alpha GitHub PyPI
- [sphinx-gp-theme](https://gp-sphinx.git-pull.com/packages/sphinx-gp-theme/): Alpha GitHub PyPI
## Build & SEO
- [sphinx-gp-llms](https://gp-sphinx.git-pull.com/packages/sphinx-gp-llms/): Alpha GitHub PyPI
- [sphinx-gp-opengraph](https://gp-sphinx.git-pull.com/packages/sphinx-gp-opengraph/): Alpha GitHub PyPI
- [sphinx-gp-sitemap](https://gp-sphinx.git-pull.com/packages/sphinx-gp-sitemap/): Alpha GitHub PyPI
- [sphinx-vite-builder](https://gp-sphinx.git-pull.com/packages/sphinx-vite-builder/): Alpha GitHub PyPI
## Documentation
- [Dependents](https://gp-sphinx.git-pull.com/packages/gp-furo-theme/dependents/): Workspace packages that declare a gp-furo-theme dependency in their pyproject.toml [project].dependencies array.
- [How to](https://gp-sphinx.git-pull.com/packages/gp-furo-theme/how-to/): The asset pipeline lives in packages/gp-furo-theme/web/:
- [Signatures (live)](https://gp-sphinx.git-pull.com/packages/gp-furo-theme/signatures/): Public callables in gp_furo_theme rendered from the running interpreter at docs-build time. Drift between this block and the prose elsewhere on the page indicates a stale docstring or signature com...
- [How to](https://gp-sphinx.git-pull.com/packages/gp-sphinx/how-to/): Shared extension defaults, theme defaults, fonts, MyST, napoleon, copybutton, and rediraffe settings.
- [Examples](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-api-style/examples/)
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-api-style/how-to/): Type badges (rightmost): function, class, method, property, attribute, data, exception — each with a distinct color
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-api-style/reference/): All badge classes are drawn from the shared sphinx_ux_badges.SAB palette. This extension uses:
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-api-style/tutorial/): No special directives are needed — existing .. autofunction::, .. argparse:: block populates a dedicated argparse domain alo...
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-argparse/tutorial/)
- [Examples](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-docutils/examples/): This page intentionally uses directive and role autodoc to document the documentation helpers themselves. If that feels a little recursive, that is the point: roles and directives should be documen...
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-docutils/how-to/): sphinx_autodoc_docutils automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately to your...
- [Kitchen sink](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-docutils/kitchen-sink/): Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-docutils/tutorial/): Use a single-object directive when you want one rendered reference entry:
- [Examples](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-fastmcp/examples/): Use for a linked badge, or for a plain inline reference.
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-fastmcp/how-to/): sphinx_autodoc_fastmcp automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately to your ...
- [Kitchen sink](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-fastmcp/kitchen-sink/): Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-fastmcp/reference/): Generated from app.add_config_value() registrations in sphinx_autodoc_fastmcp/__init__.py.
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-fastmcp/tutorial/): Render one tool card:
- [Examples](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-pytest-fixtures/examples/): Add project-specific usage notes here. The helper renders the install section, autodiscovery note, and full fixture summary/reference.
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-pytest-fixtures/how-to/): sphinx_autodoc_pytest_fixtures automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately ...
- [Kitchen sink](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-pytest-fixtures/kitchen-sink/): Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-pytest-fixtures/tutorial/): Render a standard pytest plugin page:
- [Examples](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-sphinx/examples/): This page also uses sphinx-autodoc-docutils to document the config-doc directives themselves, so the page demonstrates both config-value output and directive documentation.
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-sphinx/how-to/): sphinx_autodoc_sphinx automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately to your e...
- [Kitchen sink](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-sphinx/kitchen-sink/): Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-sphinx/reference/): Generated from app.add_directive() registrations in sphinx_autodoc_sphinx/__init__.py via sphinx-autodoc-docutils — a meta-loop where the package that documents config values uses its sibling packa...
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-sphinx/tutorial/): Render one config value:
- [Dependents](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-typehints-gp/dependents/): Workspace packages that declare a sphinx-autodoc-typehints-gp dependency in their pyproject.toml [project].dependencies array.
- [Examples](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-typehints-gp/examples/): The demos below exercise every rendering improvement sphinx-autodoc-typehints-gp ships beyond stock Sphinx + autodoc. Each section opens with a one-line “what’s interesting here”, then shows the re...
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-typehints-gp/how-to/): Two hooks run independently:
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-typehints-gp/tutorial/): Add sphinx_autodoc_typehints_gp to your extensions list in conf.py:
- [Dependents](https://gp-sphinx.git-pull.com/packages/sphinx-fonts/dependents/): Workspace packages that declare a sphinx-fonts dependency in their pyproject.toml [project].dependencies array.
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-fonts/how-to/): This site uses sphinx-fonts, so the samples below are rendered with the same template context that downstream themes receive.
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-fonts/reference/)
- [Dependents](https://gp-sphinx.git-pull.com/packages/sphinx-gp-llms/dependents/): Workspace packages that declare a sphinx-gp-llms dependency in their pyproject.toml [project].dependencies array.
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-gp-llms/how-to/): sphinx_gp_llms ships in DEFAULT_EXTENSIONS, so projects that build through merge_sphinx_config() load it automatically. Passing docs_url= to that function auto-derives the URL input the extension n...
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-gp-llms/reference/): Generated from app.add_config_value() registrations in sphinx_gp_llms/__init__.py.
- [Dependents](https://gp-sphinx.git-pull.com/packages/sphinx-gp-opengraph/dependents/): Workspace packages that declare a sphinx-gp-opengraph dependency in their pyproject.toml [project].dependencies array.
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-gp-opengraph/how-to/): sphinx_gp_opengraph ships in DEFAULT_EXTENSIONS, so projects that build through merge_sphinx_config() load it automatically. Passing docs_url= to that function auto-derives three of the most common...
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-gp-opengraph/reference/): Generated from app.add_config_value() registrations in sphinx_gp_opengraph/__init__.py.
- [Signatures (live)](https://gp-sphinx.git-pull.com/packages/sphinx-gp-opengraph/signatures/): Public callables in sphinx_gp_opengraph rendered from the running interpreter at docs-build time. Drift between this block and the prose elsewhere on the page indicates a stale docstring or signatu...
- [Dependents](https://gp-sphinx.git-pull.com/packages/sphinx-gp-sitemap/dependents/): Workspace packages that declare a sphinx-gp-sitemap dependency in their pyproject.toml [project].dependencies array.
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-gp-sitemap/how-to/): sphinx_gp_sitemap ships in DEFAULT_EXTENSIONS, so projects that build through merge_sphinx_config() load it automatically. Passing docs_url= to that function auto-derives both URL inputs the extens...
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-gp-sitemap/reference/): Generated from app.add_config_value() registrations in sphinx_gp_sitemap/__init__.py.
- [Dependents](https://gp-sphinx.git-pull.com/packages/sphinx-gp-theme/dependents/): Workspace packages that declare a sphinx-gp-theme dependency in their pyproject.toml [project].dependencies array.
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-gp-theme/how-to/): This site is rendered with sphinx-gp-theme.
- [Dependents](https://gp-sphinx.git-pull.com/packages/sphinx-ux-autodoc-layout/dependents/): Workspace packages that declare a sphinx-ux-autodoc-layout dependency in their pyproject.toml [project].dependencies array.
- [Examples](https://gp-sphinx.git-pull.com/packages/sphinx-ux-autodoc-layout/examples/): The class above renders with:
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-ux-autodoc-layout/how-to/): Hooks doctree-resolved at priority 600, after sphinx-autodoc-api-style at 500. Consumes the api_slot nodes that producer packages inject into desc_signature during earlier transforms, and composes ...
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-ux-autodoc-layout/reference/): Class
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-ux-autodoc-layout/tutorial/): Render one compact function:
- [Dependents](https://gp-sphinx.git-pull.com/packages/sphinx-ux-badges/dependents/): Workspace packages that declare a sphinx-ux-badges dependency in their pyproject.toml [project].dependencies array.
- [Examples](https://gp-sphinx.git-pull.com/packages/sphinx-ux-badges/examples/): Every variant rendered by the real build_badge / build_badge_group / build_toolbar API:
- [Explanation](https://gp-sphinx.git-pull.com/packages/sphinx-ux-badges/explanation/): All colour variants are provided by the shared palette above. Downstream extensions reference SAB.* constants instead of maintaining their own sab-* / spf-* / sas-* / sadoc-* colour classes.
- [API Reference](https://gp-sphinx.git-pull.com/packages/sphinx-ux-badges/reference/): All semantic badge colours live in sab_palettes.css (registered by this extension). Every sphinx-autodoc-* package uses the SAB.* constants instead of its own colour classes. The live demo below ...
- [Tutorial](https://gp-sphinx.git-pull.com/packages/sphinx-ux-badges/tutorial/): setup() registers the extension with Sphinx:
- [How to](https://gp-sphinx.git-pull.com/packages/sphinx-vite-builder/how-to/): Drop-in replacement for hatchling.build. Runs pnpm exec vite build before delegating wheel/sdist construction to hatchling. End users who pip install from PyPI don’t need pnpm or Node — the wheel s...
- [Code Style](https://gp-sphinx.git-pull.com/project/code-style/): gp-sphinx uses ruff for both linting and formatting.
- [Contributing](https://gp-sphinx.git-pull.com/project/contributing/): Install git and uv.
- [Releasing](https://gp-sphinx.git-pull.com/project/releasing/): gp-sphinx is pre-1.0. Minor version bumps may include breaking changes.