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.1a36.tar.gz (20.0 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.1a36-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gp_sphinx-0.0.1a36.tar.gz
Algorithm Hash digest
SHA256 fc5f0fe0279d6683b6b933607520db9555114c3cb13336d1ca3bd50535d76948
MD5 fadc60e12c39c89ef3fdccd68f90755f
BLAKE2b-256 fde51ad0a3a8c1ea8824595df4afd7c2dbd70700b78dfb34626df291cdfb02b1

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for gp_sphinx-0.0.1a36-py3-none-any.whl
Algorithm Hash digest
SHA256 14484ceaa13bdd055c6bdeca1b685a7b093ae94102d13de59099878faa4d3b46
MD5 5180050fca6404a1a4b34c21d46b2947
BLAKE2b-256 860b9c5b8a43b10f38ad668cb239ede63fb2b943c3f5e261de4ea89c11090eb0

See more details on using hashes here.

Provenance

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