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.1.0a37.tar.gz (20.7 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.1.0a37-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file gp_sphinx-0.1.0a37.tar.gz.

File metadata

  • Download URL: gp_sphinx-0.1.0a37.tar.gz
  • Upload date:
  • Size: 20.7 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.1.0a37.tar.gz
Algorithm Hash digest
SHA256 2333b433f004d7830b370649163e4fd9666408df60e32701d614ab85abaf5ac5
MD5 625c48cae7493cf6aedcb76280ea2c51
BLAKE2b-256 0bd6c0b67f83123b10b759020d68c3865027d9fbec82a6755a8b24681e5e39da

See more details on using hashes here.

Provenance

The following attestation bundles were made for gp_sphinx-0.1.0a37.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.1.0a37-py3-none-any.whl.

File metadata

  • Download URL: gp_sphinx-0.1.0a37-py3-none-any.whl
  • Upload date:
  • Size: 21.3 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.1.0a37-py3-none-any.whl
Algorithm Hash digest
SHA256 cca4bab96fb556e96b7cc6935b0d855a99526a11881017f6c8acf3514f55e337
MD5 dc1c670996e52d4d59d09a1659aafcfe
BLAKE2b-256 cf6b7f16626746f7a6ab7b4c687f966a311acbc2d017e155125f0861e9d70eba

See more details on using hashes here.

Provenance

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