qctrl-sphinx-theme 0.1.1

Q-CTRL Sphinx Theme

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

1. Add qctrl-sphinx-theme as a dev dependency in pyproject.toml.
2. Set the html_theme config value in docs/conf.py.

html_theme = "qctrl_sphinx_theme"

3. Set the html_theme_options config value in docs/conf.py.

html_theme_options = {
    "docsearch_api_key": "<YOUR_DOCSEARCH_API_KEY>",
    "docsearch_app_id": "<YOUR_DOCSEARCH_APP_ID>",
    "docsearch_index_name": "<YOUR_DOCSEARCH_INDEX_NAME>",
    "segment_write_key": "<YOUR_SEGMENT_WRITE_KEY>"
}