Q-CTRL Sphinx Theme
Project description
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
pip install qctrl-sphinx-theme
Usage
- Add
qctrl-sphinx-theme
as a dev dependency inpyproject.toml
.
[tool.poetry.dev-dependencies]
qctrl-sphinx-theme = "~1.0.0"
- Add the following to
docs/conf.py
(this sets the Q-CTRL Sphinx Theme as the theme for your documentation):
html_theme = "qctrl_sphinx_theme"
- Update (or create) the
html_theme_options
dictionary indocs/conf.py
usingqctrlsphinxtheme.get_environment_options
(this checks each DocSearch and Segment theme option for an available environment variable and, if one exists, sets it). For example:
from qctrlsphinxtheme import get_environment_options
html_theme_options.update(get_environment_options())
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
qctrl_sphinx_theme-1.0.0.tar.gz
(528.5 kB
view hashes)
Built Distribution
Close
Hashes for qctrl_sphinx_theme-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4d3e4574114aa139fbb6ce7cbf4c8d20b0fa7ada8ea0e17d79816933b870698 |
|
MD5 | 65b397304d17775d468569a91cb65513 |
|
BLAKE2b-256 | f249153561ef8e96930bf300f9ab5aeb3899cc1e5a9d37e9b0a5177bca769e5d |