gp-sphinx

Shared Sphinx documentation platform for git-pull projects.

Quickstart

Install and get started in minutes.

Quickstart
Packages

Eight 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)