A Sphinx theme for sites hosted at palewi.re
Project description
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, you can control which elements are included in the sidebar by adding the html_sidebars
option to your conf.py
file. Here's an example that includes the default sidebar elements:
html_sidebars = {
"**": [
"about.html",
"navigation.html",
]
}
Further configution of this setting is explained by the Sphinx documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinx_palewire_theme-0.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8b467bdd845abfc305611eb09a099e62a55d8eddb0b6ac95557bd4025d75b21 |
|
MD5 | 88d8119c9261b4e4434b0cb53fd028c7 |
|
BLAKE2b-256 | 4002dc3bf996a7374c8600b2644b531099188d33e6c316d4c8787cb24f2db033 |