A Tyrian based Sphinx theme for Gentoo
Project description
Tyrian Sphinx Theme
A Sphinx theme based on Tyrian (the new unified gentoo.org theme).
Installation
You can install the theme using
$ pip install git+https://github.com/mmagorsc/tyrian_sphinx_theme/#egg=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
- the link to the license that will be used when clicking on the license in the footer
- https://creativecommons.org/licenses/by-sa/4.0/ (default)
Contributors
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.3.tar.gz
(14.4 kB
view hashes)
Built Distribution
Close
Hashes for tyrian-sphinx-theme-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 595d5983d0a5a5cfd53d7268620afa5a3b02be51a06441310e48d01ea3fee60b |
|
MD5 | 32652db46fc64da2f58e64a929cafeaa |
|
BLAKE2b-256 | 3ae6b6ec18a06706b51d943a559a358fdcabf4ffcdc24c89993b47d9e5f2a7a6 |
Close
Hashes for tyrian_sphinx_theme-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06be7aa90a116121c408ae550d63dc42a967cafada0c12bef7fd104365540e19 |
|
MD5 | 845745fc2ea3fac4572a9613f564c45e |
|
BLAKE2b-256 | 151a42edcb47576101f0d4ac102c5d9855d415e4a8f4f4daab5fdc9087e176cd |