A Sphinx theme based on Tyrian (the new unified gentoo.org theme).
You can use pip to install the theme:
$ pip install tyrian-sphinx-theme
The appereance of the theme can be adjusted using different builders as well as further html_theme_options:
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 ...
- 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
- 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
- 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
- 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
- the license that will be display in the footer
- CC-BY-SA-4.0 (default)
- 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)
Contributions are welcome. You have an idea, suggestion for improvement or have found a bug? Just create an issue or send a pull request.