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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_palewire_theme-0.1.10.tar.gz.
File metadata
- Download URL: sphinx_palewire_theme-0.1.10.tar.gz
- Upload date:
- Size: 106.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
415712185cae43328ccd9fbc40ad2d84643d91900a241a5f93b62ea3cb19baac
|
|
| MD5 |
f238b57a9884ca38941fbd987ab19f98
|
|
| BLAKE2b-256 |
223fc5d5357ce93abcb9b066a648f596ee028c4a44d05debe192b331e75c68a3
|
Provenance
The following attestation bundles were made for sphinx_palewire_theme-0.1.10.tar.gz:
Publisher:
continuous-deployment.yaml on palewire/sphinx-palewire-theme
-
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.10.tar.gz -
Subject digest:
415712185cae43328ccd9fbc40ad2d84643d91900a241a5f93b62ea3cb19baac - Sigstore transparency entry: 2624696535
- Sigstore integration time:
-
Permalink:
palewire/sphinx-palewire-theme@9ff4924b3986bf5a8c2147fae6b410ec95e99aa7 -
Branch / Tag:
refs/tags/0.1.10 - Owner: https://github.com/palewire
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
continuous-deployment.yaml@9ff4924b3986bf5a8c2147fae6b410ec95e99aa7 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_palewire_theme-0.1.10-py3-none-any.whl.
File metadata
- Download URL: sphinx_palewire_theme-0.1.10-py3-none-any.whl
- Upload date:
- Size: 15.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a16f04c17d55f210ee02d80db55c56372de766797a47fcf7b1a7ff23b3c411e0
|
|
| MD5 |
a8a5edad310b287b750a7ff19e108b26
|
|
| BLAKE2b-256 |
f35b336a782387ceed979bb99b76aeefbd856a59750b7fcad22fdff66f638004
|
Provenance
The following attestation bundles were made for sphinx_palewire_theme-0.1.10-py3-none-any.whl:
Publisher:
continuous-deployment.yaml on palewire/sphinx-palewire-theme
-
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.10-py3-none-any.whl -
Subject digest:
a16f04c17d55f210ee02d80db55c56372de766797a47fcf7b1a7ff23b3c411e0 - Sigstore transparency entry: 2624696546
- Sigstore integration time:
-
Permalink:
palewire/sphinx-palewire-theme@9ff4924b3986bf5a8c2147fae6b410ec95e99aa7 -
Branch / Tag:
refs/tags/0.1.10 - Owner: https://github.com/palewire
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
continuous-deployment.yaml@9ff4924b3986bf5a8c2147fae6b410ec95e99aa7 -
Trigger Event:
push
-
Statement type:
