Skip to main content

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.

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

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.6.tar.gz (120.3 kB view details)

Uploaded Source

Built Distribution

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

sphinx_palewire_theme-0.1.6-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_palewire_theme-0.1.6.tar.gz
  • Upload date:
  • Size: 120.3 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.6.tar.gz
Algorithm Hash digest
SHA256 96be0cd601f7bdd0690a22ed7abe9014c737779bd72dc622f540cd75d1eb7e1b
MD5 fc7925a72af1d4f95edf86f7d09df6f3
BLAKE2b-256 79ac553c0b458fec032c631e1200e48f9c2982260f0ca15c998cf345bb26da73

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_palewire_theme-0.1.6.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.

File details

Details for the file sphinx_palewire_theme-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_palewire_theme-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5bf02abbe3497ba7fde7f1366d22d968cfb5917b1872f4056c16da84fda3030a
MD5 5e9d7c6ea0886e7da0ddb2c8b6398606
BLAKE2b-256 c0f80fe4f3cb7777384eeb61e29a7b8bba90fa086250aa59fe9acbc2b4577e38

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_palewire_theme-0.1.6-py3-none-any.whl:

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.

Release history Release notifications | RSS feed

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

This release

0.1.6 This release

2 files

0.1.5

1 file

0.1.4

1 file

0.1.3

1 file

0.1.2

1 file

0.1.1

1 file

0.0.18

1 file

0.0.17

1 file

0.0.16

1 file

0.0.15

1 file

0.0.14

1 file

0.0.13

1 file

0.0.12

1 file

0.0.11

1 file

0.0.10

1 file

0.0.9

1 file

0.0.8

1 file

0.0.7

1 file

0.0.6

1 file

0.0.5

1 file

0.0.4

1 file

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

0.0.0

1 file

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