Skip to main content

Shared Sphinx documentation platform for git-pull projects

Project description

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

Project details


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.1a13.tar.gz (16.5 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.1a13-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gp_sphinx-0.0.1a13.tar.gz
  • Upload date:
  • Size: 16.5 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.1a13.tar.gz
Algorithm Hash digest
SHA256 59237c484f8e5e5e0818ba3279602653348551a9946a6eb4a60fb514933777f9
MD5 d76719aeaa4130913655a7d534859336
BLAKE2b-256 50d8abf17835495f654ac2715b6f079780c1e3b2d20c8c2492072fa263c20c46

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: gp_sphinx-0.0.1a13-py3-none-any.whl
  • Upload date:
  • Size: 17.0 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.1a13-py3-none-any.whl
Algorithm Hash digest
SHA256 dfede670b239cc93bd6b60535b5caf0e0f3ae6919687861ee3c11606289f04ec
MD5 5e03033953bb1e6af628e6dea48939cf
BLAKE2b-256 08dbf9707771b6849a3ec8a52a0604329ab91f946b97781e2380b993d7bea705

See more details on using hashes here.

Provenance

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

Supported by

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