sphinx-palewire-theme

A Sphinx theme for sites hosted at palewi.re.

Installation

Install the theme with pipenv:

pipenv install palewire-sphinx-theme

Then, in your Sphinx project's conf.py file, add the following line:

html_theme = "palewire"

Configuration

The theme supports two different layouts, a "wide" layout and a "narrow" layout. The wide layout that includes a sidebar is the default. You can switch to the narrow single-column layout by adding the following line to your conf.py file:

html_theme_options = {
    "nosidebar": True,
}

When using the wide layout, configure the sidebar with the theme's page navigation template. It renders links from your site's top-level toctree, not the current page's section headings. Previous and next page links are rendered in the responsive footer navigation on mobile.

html_sidebars = {
    "**": [
        "about.html",
        "navigation.html",
        "searchbox.html",
    ]
}

Do not add localtoc.html or relations.html to this configuration. Further configuration of this setting is explained by the Sphinx documentation.

The theme supports the current Sphinx search form markup. It does not set an upper bound on Sphinx versions.

Quick start

Install the theme, then create a minimal Sphinx configuration:

uv add sphinx-palewire-theme
uvx sphinx-palewire-theme init

The initializer asks for the site metadata and creates conf.py. It enables the palewire extension, which supplies the standard sidebar and canonical URL defaults. Use --layout narrow for a single-column site or --navigation minimal to hide the sidebar.

For an existing configuration, add these settings:

extensions = ["palewire"]

html_theme = "palewire"
html_baseurl = "https://palewi.re/docs/my-site/"
palewire_layout = "wide"
palewire_navigation = "sidebar"

Development

Install the locked development tools and run the same checks used in CI:

uv sync --all-groups
uv run pre-commit run --all-files
uv run python -m unittest discover -s tests
uv run sphinx-build -W -b html docs docs/_build/html
uv run sphinx-build -W -b linkcheck docs docs/_build/linkcheck

Download files

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

Source Distribution

sphinx_palewire_theme-0.1.9.tar.gz (106.0 kB view details)

Uploaded Aug 28, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_palewire_theme-0.1.9-py3-none-any.whl (15.5 kB view details)

Uploaded Aug 28, 2026 Python 3

File details

Details for the file sphinx_palewire_theme-0.1.9.tar.gz.

File metadata

Download URL: sphinx_palewire_theme-0.1.9.tar.gz
Upload date: Aug 28, 2026
Size: 106.0 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sphinx_palewire_theme-0.1.9.tar.gz
Algorithm	Hash digest
SHA256	`b86d139d75f24892d193ad8c15e18e035be53cce7fcba5c8de0dc5594c78f874`
MD5	`9301e4a022dcc74dfc5eb4bae1ea81ad`
BLAKE2b-256	`4103bcb67785f50a782e938cfa9303dc2923e475b75d0f96f5a893120e5dce5b`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_palewire_theme-0.1.9.tar.gz:

Publisher: continuous-deployment.yaml on palewire/sphinx-palewire-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_palewire_theme-0.1.9.tar.gz
- Subject digest: b86d139d75f24892d193ad8c15e18e035be53cce7fcba5c8de0dc5594c78f874
- Sigstore transparency entry: 2624554675
- Sigstore integration time: Aug 28, 2026
Source repository:
- Permalink: palewire/sphinx-palewire-theme@fa3f06543192973d4f120dd1552150a5877672ed
- Branch / Tag: refs/tags/0.1.9
- Owner: https://github.com/palewire
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: continuous-deployment.yaml@fa3f06543192973d4f120dd1552150a5877672ed
- Trigger Event: push