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.
gp-sphinx is the umbrella entry point — its
merge_sphinx_config() wires up the full stack for
downstream projects in ~10 lines of conf.py. Every other package is opt-in
and independently installable.
Common libraries¶
The rendering pipeline every autodoc extension consumes, plus shared page primitives:
sphinx-ux-badges— badge primitives and colour palettesphinx-ux-autodoc-layout— structural presenter forapi-*entry componentssphinx-autodoc-typehints-gp— annotation normalization and type renderingsphinx-fonts— IBM Plex font preloadingsphinx-gp-mermaid— build-time mermaid diagrams as dual-theme inline SVG
Code highlighting¶
Pygments lexers and inline literal helpers for code-heavy documentation:
sphinx-gp-highlighting— directory-tree code blocks and inline command/path highlighting
Autodoc extensions¶
Domain-specific autodoc extensions — each adds directives that generate documentation from a particular source-construct family (Python APIs, argparse parsers, pytest fixtures, etc.):
sphinx-autodoc-api-style— Python API rendering stylesphinx-autodoc-argparse— argparse parsers + subcommandssphinx-autodoc-docutils— docutils directives + nodessphinx-autodoc-fastmcp— FastMCP tools, prompts, resourcessphinx-autodoc-pytest-fixtures— pytest fixturessphinx-autodoc-sphinx— Sphinx config values
Build utils¶
PEP 517 backends and orchestration helpers for theme asset pipelines:
sphinx-vite-builder— PEP 517 backend + Sphinx extension that runs Vite via pnpm
Theme and coordinator¶
Shared Sphinx configuration and presentation assets:
gp-sphinx— umbrella coordinator (merge_sphinx_config())sphinx-gp-theme— Furo child theme with the gp-sphinx default palettegp-furo-theme— Tailwind v4 port of upstream Furo for git-pull projects
SEO and agent formats¶
Meta-tag, crawlability, and LLM-friendly output extensions auto-loaded by gp-sphinx when docs_url is set:
sphinx-gp-opengraph— Open Graph + Twitter Card meta tagssphinx-gp-sitemap—sitemap.xmlfor crawl indexingsphinx-gp-llms—llms.txt,llms-full.txt,docs.json, per-page.mdtwins
Design philosophy¶
Together, the common libraries provide one autodoc design system: every autodoc extension shares the same badge palette, the same componentized HTML output structure, and the same static type annotation pipeline — so Python APIs, pytest fixtures, Sphinx config values, docutils directives, and FastMCP tools all look like they belong together.
All workspace packages¶
Tailwind v4 port of the Furo Sphinx theme for git-pull project documentation
Shared Sphinx documentation platform for git-pull projects
Sphinx extension for enhanced autodoc API entry styling (badges and cards)
Modern Sphinx extension for documenting argparse-based CLI tools
Sphinx extension for documenting docutils directives and roles as first-class reference entries
Sphinx extension for documenting FastMCP tools (cards, badges, cross-refs)
Sphinx extension for documenting pytest fixtures as first-class objects
Sphinx extension for documenting extension config values as first-class conf.py reference entries
Cross-referenced type annotations for Sphinx autodoc
Sphinx extension for self-hosted fonts via Fontsource CDN
Reusable Pygments lexers and inline highlighting for Sphinx
LLM-friendly documentation outputs for Sphinx — llms.txt, llms-full.txt, docs.json, per-page Markdown
Build-time Mermaid diagrams for Sphinx — dual light/dark inline SVG rendered via mermaid-cli
OpenGraph and Twitter meta-tag emission for Sphinx — matplotlib-free
Sitemap generator for Sphinx — Sphinx 8.1+ idioms, parallel-build safe
Furo child theme for git-pull project documentation
Componentized layout for Sphinx autodoc output
Shared badge node and CSS for Sphinx autodoc extensions
PEP 517 build backend + Sphinx extension that orchestrates Vite via pnpm