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.5.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

tyrian_sphinx_theme-0.0.5-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file tyrian-sphinx-theme-0.0.5.tar.gz.

File metadata

  • Download URL: tyrian-sphinx-theme-0.0.5.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.8.1

File hashes

Hashes for tyrian-sphinx-theme-0.0.5.tar.gz
Algorithm Hash digest
SHA256 9c20f85551dfb1fce59e8581cfeaf2749ac277d306c7bb0e4852f172ee6edcba
MD5 e2876b78017853ef02d6ad7bfb9917ba
BLAKE2b-256 07e08dbe9a8f7f2cce3856441e8248b374d916549d28e6c232bb370c5850233f

See more details on using hashes here.

File details

Details for the file tyrian_sphinx_theme-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: tyrian_sphinx_theme-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 16.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.8.1

File hashes

Hashes for tyrian_sphinx_theme-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b70f6f9c06e149c33577403520d0adebf7d21f13be9458fd836fb9e86876ac3f
MD5 597ee525310c0efcebaca228f991c708
BLAKE2b-256 fa27f2cda34ee9cae6980b7f1adb5c1bbddf667f107d7b95b91d68487d1414cf

See more details on using hashes here.

Supported by

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