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
Metadata
2 maintainers
Release files for tyrian-sphinx-theme 0.0.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| tyrian_sphinx_theme-0.0.9.tar.gz | 14.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tyrian_sphinx_theme-0.0.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 30.0 kB
Release files / tyrian_sphinx_theme-0.0.9.tar.gz
| Download URL | tyrian_sphinx_theme-0.0.9.tar.gz |
|---|---|
| Size | 14.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0354fe35f4476735b278fd4966a6cd491dddd884bcb795164b51a827f42fab26
|
|
BLAKE2b-256 checksum How to use checksums |
c555175c90f3cea20d06a1703994d7863fc4445a0c1cd4db4eb0c35da88e711b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Release files / tyrian_sphinx_theme-0.0.9-py3-none-any.whl
| Download URL | tyrian_sphinx_theme-0.0.9-py3-none-any.whl |
|---|---|
| Size | 15.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4216a089e30029b800e08bc2b2e1a245f7651c876483a19ce70c4dacd98751db
|
|
BLAKE2b-256 checksum How to use checksums |
91ece3dca77e9ff86cf256bfde467cc8f53dd41e30c7415297b77576a40aaa63
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Security for tyrian-sphinx-theme 0.0.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
