Skip to main content

A Tyrian based Sphinx theme for Gentoo

Project description

PyPI version

Table Of Contents

Basic Overview

A Sphinx theme based on Tyrian (the new unified gentoo.org theme).

Screenshot

Installation

You can use pip to install the theme:

$ pip install tyrian-sphinx-theme

Configuration

The appereance of the theme can be adjusted using different builders as well as further html_theme_options:

builders

It is possible to use two different builders:

  • html-builder (default): Creates multiple pages, i.e. one page per file
  • singlehtml-builder: Creates a single large page, containing the whole content

You can specify the builder using sphinx command line options like:

$ sphinx-build -b singlehtml ...

sidebar

  • right (default): display the sidebar on the right side of the page
  • left: display the sidebar on the left side of the page
  • none: don't display the sidebar on the page at all

navigationlinks_top

  • short: display the links using "<< >>"
  • long: display the links using "<< chapter-heading chapter-heading >>"
  • none (default): don't display the navigation links on top at all

navigationlinks_bottom

  • short: display the links using "<< >>"
  • long (default): display the links using "<< chapter-heading chapter-heading >>"
  • none: don't display the navigation links at the bottom at all

navigationlinks_navbar

  • short: display the links using "<< >>"
  • long: display the links using "<< chapter-heading chapter-heading >>"
  • none (default): don't display the navigation links in the navbar at all

license

  • the license that will be display in the footer
  • CC-BY-SA-4.0 (default)

license_link

Contributors

Contributing

Contributions are welcome. You have an idea, suggestion for improvement or have found a bug? Just create an issue or send a pull request.

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

tyrian-sphinx-theme-0.0.7.tar.gz (4.5 kB view hashes)

Uploaded source

Built Distribution

tyrian_sphinx_theme-0.0.7-py3-none-any.whl (17.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page