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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_gp_theme-0.1.0a37.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.1.0a37.tar.gz
Algorithm Hash digest
SHA256 6bd1248433d197aadaa2c6ceb01975b71ba9f8395db1f3e6bfd3ce98913bf4f7
MD5 5ccde25d72177102a4ff8ded7772dcf9
BLAKE2b-256 f364738adee88ecec4c3a8286da75d701062ac711c88b01b9713275329f7bc28

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_gp_theme-0.1.0a37-py3-none-any.whl
Algorithm Hash digest
SHA256 afac9135c2d9eec3caa3dbff862509ea64802294c62191590c98ad9ebe9da2cc
MD5 c96a15dec2921cda7ac2a693c4d82f6c
BLAKE2b-256 65475901ff6adc10cdf2812a8b0bb138e65f6d123ee89703b20a82ed54354fae

See more details on using hashes here.

Provenance

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

This release

0.1.0a37 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