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_html_theme_options
(this checks each DocSearch and Segment theme option for an available environment variable and, if one exists, sets it). For example:
To update an html_theme_options
dictionary:
from qctrlsphinxtheme import get_html_theme_options
html_theme_options.update(get_html_theme_options())
To create a html_theme_options
dictionary:
from qctrlsphinxtheme import get_html_theme_options
html_theme_options = get_html_theme_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.1.tar.gz
(528.6 kB
view hashes)
Built Distribution
Close
Hashes for qctrl_sphinx_theme-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27dea8532769b087d6722f35564043e69744f30308f5039ba961ad244115e2f5 |
|
MD5 | 7a1c3286de81a8d96b2083fa3b261c27 |
|
BLAKE2b-256 | 8095e9aacc931d456154da8ea55a58744e8fa93ccc79595c1d95dda65833db4d |