Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

gp-sphinx · Python Package License

Shared Sphinx documentation platform for git-pull projects.

Consolidates duplicated docs configuration, extensions, theme settings, and workarounds from 14+ repositories into a single reusable package.

Install

$ pip install gp-sphinx
$ uv add gp-sphinx

Usage

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

"""Sphinx configuration for my-project."""
from __future__ import annotations

from gp_sphinx.config import merge_sphinx_config

import my_project

conf = merge_sphinx_config(
    project="my-project",
    version=my_project.__version__,
    copyright="2026, Tony Narlock",
    source_repository="https://github.com/git-pull/my-project/",
    intersphinx_mapping={
        "py": ("https://docs.python.org/", None),
    },
)
globals().update(conf)

Features

  • merge_sphinx_config() API for shared defaults with per-project overrides
  • Shared extension list (autodoc, intersphinx, myst_parser, sphinx_design, etc.)
  • Shared Furo theme configuration (CSS variables, fonts, sidebar, footer)
  • Bundled workarounds (tabs.js removal, spa-nav.js injection)
  • Shared font configuration (IBM Plex via Fontsource)

More information

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gp_sphinx-0.0.1a32.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gp_sphinx-0.0.1a32-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file gp_sphinx-0.0.1a32.tar.gz.

File metadata

  • Download URL: gp_sphinx-0.0.1a32.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gp_sphinx-0.0.1a32.tar.gz
Algorithm Hash digest
SHA256 2eca9add0fc6b0d0d72c96faa13d14d7c25edcb87041c0e5eea82d342e120e76
MD5 4f4f89080e3fca6aba043069d84f3320
BLAKE2b-256 bfd5d3368d24f899bb0914632be7a982e7c2ecf8e3eb6f7fad527c2e1b3e8de6

See more details on using hashes here.

Provenance

The following attestation bundles were made for gp_sphinx-0.0.1a32.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gp_sphinx-0.0.1a32-py3-none-any.whl.

File metadata

  • Download URL: gp_sphinx-0.0.1a32-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for gp_sphinx-0.0.1a32-py3-none-any.whl
Algorithm Hash digest
SHA256 ebcd29e0afbdd414b0ad7e66439c2b4ca2de2ea45ca7c3da4df8c0e06220b952
MD5 06bc4408ead6b87cb28406d9d03c471b
BLAKE2b-256 b8e8ca57b2e4c51b5c0c159dd1eec70e4e40ddfa72260402b64124bf35267b0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for gp_sphinx-0.0.1a32-py3-none-any.whl:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page