Q-CTRL Sphinx Theme
The Q-CTRL Sphinx Theme is a very opinionated Sphinx theme intended for use with public Q-CTRL Documentation websites such as the Q-CTRL Python package.
Installation
- Install the Q-CTRL Sphinx Theme package.
pip install qctrl-sphinx-theme
- Add
qctrl-sphinx-themeas a dev dependency in yourpyproject.tomlfile. - Add the following to your project’s
conf.pyfile:html_theme = "qctrl_sphinx_theme"
Configuration
The Q-CTRL Sphinx Theme requires no configuration and there is no need to set any html_theme_options in your project’s conf.py file. The theme will automatically set all necessary theme options and will update any theme option with an available environment variable if one exists.
2 maintainers
Metadata
2 maintainers
Release files for qctrl-sphinx-theme 2.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qctrl_sphinx_theme-2.1.4.tar.gz | 528.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qctrl_sphinx_theme-2.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.1 MB
Release files / qctrl_sphinx_theme-2.1.4.tar.gz
| Download URL | qctrl_sphinx_theme-2.1.4.tar.gz |
|---|---|
| Size | 528.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d5ccf2d7e582be2555b57a277dcea401e69cd25aca23391338f9abc48f287a72
|
|
BLAKE2b-256 checksum How to use checksums |
057ec86e95bb6cafb664fa5e6fcfa0834e9351f8724d6993126e8161ee8e7f8f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.9.18 Linux/6.2.0-1016-azure
|
Release files / qctrl_sphinx_theme-2.1.4-py3-none-any.whl
| Download URL | qctrl_sphinx_theme-2.1.4-py3-none-any.whl |
|---|---|
| Size | 531.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d9ad06c958f88ce8406818b68e1b6c78d514144199214d01be787951fd442a9d
|
|
BLAKE2b-256 checksum How to use checksums |
481945f68a68e250620ea64e791151c8056e0f10e7245e26043496ee6be2e151
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.9.18 Linux/6.2.0-1016-azure
|
