Metadata-Version: 2.1
Name: qctrl-sphinx-theme
Version: 1.0.0
Summary: Q-CTRL Sphinx Theme
Home-page: https://q-ctrl.com
License: https://q-ctrl.com/terms
Keywords: black opal,boulder opal,fire opal,nisq,open controls,q control,q ctrl,q-control,q-ctrl,qcontrol,qctrl,quantum,quantum algorithms,quantum circuits,quantum coding,quantum coding software,quantum computing,quantum control,quantum control software,quantum control theory,quantum engineering,quantum error correction,quantum firmware,quantum fundamentals,quantum sensing,qubit,qudit
Author: Q-CTRL
Author-email: support@q-ctrl.com
Maintainer: Q-CTRL
Maintainer-email: support@q-ctrl.com
Requires-Python: >=3.8,<3.12
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: System :: Distributed Computing
Requires-Dist: sphinx (>=5.0.0,<6.0.0)
Requires-Dist: sphinx_rtd_theme (>=1.2.0,<1.3.0)
Project-URL: Facebook, https://www.facebook.com/qctrl
Project-URL: GitHub, https://github.com/qctrl
Project-URL: LinkedIn, https://www.linkedin.com/company/q-ctrl/
Project-URL: Twitter, https://twitter.com/qctrlHQ
Project-URL: YouTube, https://www.youtube.com/qctrl
Description-Content-Type: text/markdown

# Q-CTRL Sphinx Theme

The Q-CTRL Sphinx Theme is a very opinionated [Sphinx](https://www.sphinx-doc.org/) theme intended for use with public [Q-CTRL Documentation](https://docs.q-ctrl.com/) websites such as the [Q-CTRL Python package](https://docs.q-ctrl.com/boulder-opal/references/qctrl/).

## Installation

```shell
pip install qctrl-sphinx-theme
```

## Usage

1. Add `qctrl-sphinx-theme` as a dev dependency in `pyproject.toml`.
```toml
[tool.poetry.dev-dependencies]
qctrl-sphinx-theme = "~1.0.0"
```
1. Add the following to `docs/conf.py` (this sets the Q-CTRL Sphinx Theme as the theme for your documentation):
  ```python
  html_theme = "qctrl_sphinx_theme"
  ```
1. Update (or create) the `html_theme_options` dictionary in `docs/conf.py` using `qctrlsphinxtheme.get_environment_options` (this checks each DocSearch and Segment theme option for an available environment variable and, if one exists, sets it). For example:
  ```python
  from qctrlsphinxtheme import get_environment_options
  html_theme_options.update(get_environment_options())
  ```

