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.1a33.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.1a33-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gp_sphinx-0.0.1a33.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.1a33.tar.gz
Algorithm Hash digest
SHA256 f4641cb9ca80bc27ff0d56fba7d52d0ae551e6af1b2f29ef934442d05abfd1cf
MD5 188a0ecb64759fd84809e4330099f394
BLAKE2b-256 f32477c1e04cc5ba09a6ee86f4a9ae9c32188d9fd130ded03a85bbcfdfb4f697

See more details on using hashes here.

Provenance

The following attestation bundles were made for gp_sphinx-0.0.1a33.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.1a33-py3-none-any.whl.

File metadata

  • Download URL: gp_sphinx-0.0.1a33-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.1a33-py3-none-any.whl
Algorithm Hash digest
SHA256 c5447abf6c300514accf917e93fd93d1893dda5c1d929e0b2f31d2e0967ff1d5
MD5 ff993d2f957b959c78269091e6d1adee
BLAKE2b-256 203c02dd665b29fad830a696873a9f33abc675c2259a0add1c596279a7526836

See more details on using hashes here.

Provenance

The following attestation bundles were made for gp_sphinx-0.0.1a33-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