Skip to main content
Pre-release

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

sphinx-gp-theme

Furo child theme for git-pull project documentation.

Inherits from Furo and bundles shared templates, custom CSS (heading refinements, TOC, typography, view transitions), SPA navigation JS, and the git-pull project sidebar.

Install

$ pip install sphinx-gp-theme

Usage

In your docs/conf.py:

html_theme = "sphinx-gp-theme"

Or use with gp-sphinx which sets the theme automatically.

JavaScript events

The bundled SPA-navigation layer dispatches the following CustomEvents on document:

Event When event.detail
gp-sphinx:navigated After an SPA page swap completes — the new .article-container / .sidebar-tree / .toc-drawer are in the DOM and the built-in reinit (copybutton, scroll-spy, theme toggle) has run. { url: string } — the new page URL.

Widgets that bind event listeners to DOM inside .article-container should listen for gp-sphinx:navigated in addition to DOMContentLoaded, because that region is replaced in-place on every link click and old listeners are destroyed along with it. Listeners on document or window (including those added inside the handler) persist across swaps.

Minimal pattern:

function init() {
  document.querySelectorAll(".my-widget").forEach(/* ... */);
}
document.addEventListener("DOMContentLoaded", init);
document.addEventListener("gp-sphinx:navigated", init);

Download files

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

Source Distribution

sphinx_gp_theme-0.0.1a35.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

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

sphinx_gp_theme-0.0.1a35-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_gp_theme-0.0.1a35.tar.gz.

File metadata

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

File hashes

Hashes for sphinx_gp_theme-0.0.1a35.tar.gz
Algorithm Hash digest
SHA256 8c699698cbe65fbdbe6d64201778c4339c4f9707feb6c618c8f4bad6dc191bf0
MD5 0d2fb442359bf15dafd1325d906b68b0
BLAKE2b-256 5433c70d2736ad56f10dfda3086a5001aec03da53197aeb7289c3e20a4b53547

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_gp_theme-0.0.1a35-py3-none-any.whl
Algorithm Hash digest
SHA256 5978fe159e467e3263383850331ff14d3f814631e060883764f68278068e0d36
MD5 c517d7ebb2dae33e6fdd30358d0e1fce
BLAKE2b-256 57d9eed280cbae7110e6930b134605c2e6be76350b67b7fcbb47e25e9ea7b3e3

See more details on using hashes here.

Provenance

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

This release

0.0.1a35 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page