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.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2726a80349b9acba77be561bfde0e35d351b0c4f10c873703690b1763e784e8e |
|
MD5 | acb72d9335b84154fec3a545984ab484 |
|
BLAKE2b-256 | f9faa6aca2848c39fa76673d1d962e65f68e83e50694f61c306f8b00132b9857 |