Table Of Contents
Basic Overview
A Sphinx theme based on Tyrian (the new unified gentoo.org theme).
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
- 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
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.
2 maintainers
Release files for tyrian-sphinx-theme 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tyrian-sphinx-theme-0.0.5.tar.gz | 4.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tyrian_sphinx_theme-0.0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.4 kB
Release files / tyrian-sphinx-theme-0.0.5.tar.gz
| Download URL | tyrian-sphinx-theme-0.0.5.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9c20f85551dfb1fce59e8581cfeaf2749ac277d306c7bb0e4852f172ee6edcba
|
|
BLAKE2b-256 checksum How to use checksums |
07e08dbe9a8f7f2cce3856441e8248b374d916549d28e6c232bb370c5850233f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / tyrian_sphinx_theme-0.0.5-py3-none-any.whl
| Download URL | tyrian_sphinx_theme-0.0.5-py3-none-any.whl |
|---|---|
| Size | 16.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b70f6f9c06e149c33577403520d0adebf7d21f13be9458fd836fb9e86876ac3f
|
|
BLAKE2b-256 checksum How to use checksums |
fa27f2cda34ee9cae6980b7f1adb5c1bbddf667f107d7b95b91d68487d1414cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
