qctrl-sphinx-theme 2.1.4

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

1. Install the Q-CTRL Sphinx Theme package.

   pip install qctrl-sphinx-theme
   

2. Add qctrl-sphinx-theme as a dev dependency in your pyproject.toml file.
3. Add the following to your project’s conf.py file:

   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.