gp-sphinx

Integrated autodoc design system for git-pull Sphinx projects.

What’s New

The unified autodoc design system — seven major advancements.

What’s new
Gallery

Visual showcase of the autodoc design system in action.

Gallery
Architecture

Three-tier package organization — infrastructure, domain, and presentation.

Architecture
Quickstart

Install and get started in minutes.

Quickstart
Packages

Twelve workspace packages — coordinator, extensions, and theme.

Packages
Configuration

Parameter reference for merge_sphinx_config() and shared defaults.

Configuration

Install

$ pip install gp-sphinx

$ uv add gp-sphinx

At a glance

Replace ~300 lines of duplicated docs/conf.py with ~10 lines:

from gp_sphinx.config import merge_sphinx_config

conf = merge_sphinx_config(
    project="my-project",
    version="1.0.0",
    copyright="2026, Tony Narlock",
    source_repository="https://github.com/git-pull/my-project/",
)
globals().update(conf)

What you get

Out of the box, merge_sphinx_config() activates:

  • Unified badge system — type and modifier badges for functions, classes, fixtures, tools

  • Componentized layout — card containers, parameter folding, managed signatures

  • Clean type hints — simplified annotations with cross-referenced links

  • Five domain autodocumenters — Python API, pytest fixtures, FastMCP tools, docutils, Sphinx config

  • IBM Plex fonts — professional typography with preloaded web fonts

  • Dark mode — full light/dark theming via CSS custom properties

See the Gallery to see these in action.