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 and is the default, but 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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0d0de80ba21d552204aa1caa744aeac2a7c103723d905d1dd91f67a5ae27ed9 |
|
MD5 | 5aa11a92d018425535463833ab1c9523 |
|
BLAKE2b-256 | 73fde6b5e26ada80022bc2a1a278f69df751cc3a8b6cb76d7611865b13575456 |