Skip to main content

Furo child theme for git-pull project documentation

Project description

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);

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

sphinx_gp_theme-0.0.1a11.tar.gz (16.1 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.1a11-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_gp_theme-0.0.1a11.tar.gz
Algorithm Hash digest
SHA256 9c1523e2417a7e409af7afd342e8588ee9616bbd4b9557290534900854dac92e
MD5 399438d438f0215e0406c0799dde8c95
BLAKE2b-256 0f89efcb4c91cd6d71f00946e903cd622428d8331c9faaad972c18b4a55dc259

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_gp_theme-0.0.1a11-py3-none-any.whl
Algorithm Hash digest
SHA256 9820e871871f7485bd0aec345b1942feb1bf30ef847068ae74e7bf25428b83a7
MD5 2e66d298afd3ba37554a44a639a95604
BLAKE2b-256 183f10a5cd41010f2c30a48662d7b2109e3b2f076d1550320f5fbb7724d10539

See more details on using hashes here.

Provenance

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