Skip to main content

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


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.0.12.tar.gz (12.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page