# 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
1. Install the Q-CTRL Sphinx Theme package.
```shell
pip install qctrl-sphinx-theme
```
1. Add `qctrl-sphinx-theme` as a dev dependency in your `pyproject.toml` file.
1. Add the following to your project’s `conf.py` file:
```python
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.
Raw data
{
"_id": null,
"home_page": "https://q-ctrl.com",
"name": "qctrl-sphinx-theme",
"maintainer": "Q-CTRL",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "support@q-ctrl.com",
"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",
"download_url": "https://files.pythonhosted.org/packages/05/7e/c86e95bb6cafb664fa5e6fcfa0834e9351f8724d6993126e8161ee8e7f8f/qctrl_sphinx_theme-2.1.4.tar.gz",
"platform": null,
"description": "# Q-CTRL Sphinx Theme\n\nThe 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/).\n\n## Installation\n\n1. Install the Q-CTRL Sphinx Theme package.\n ```shell\n pip install qctrl-sphinx-theme\n ```\n1. Add `qctrl-sphinx-theme` as a dev dependency in your `pyproject.toml` file.\n1. Add the following to your project\u2019s `conf.py` file:\n ```python\n html_theme = \"qctrl_sphinx_theme\"\n ```\n\n## Configuration\n\nThe Q-CTRL Sphinx Theme requires no configuration and there is no need to set any `html_theme_options` in your project\u2019s `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.\n",
"bugtrack_url": null,
"license": "https://q-ctrl.com/terms",
"summary": "Q-CTRL Sphinx Theme",
"version": "2.1.4",
"project_urls": {
"Facebook": "https://www.facebook.com/qctrl",
"GitHub": "https://github.com/qctrl",
"Homepage": "https://q-ctrl.com",
"LinkedIn": "https://www.linkedin.com/company/q-ctrl/",
"Twitter": "https://twitter.com/qctrlHQ",
"YouTube": "https://www.youtube.com/qctrl"
},
"split_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"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "481945f68a68e250620ea64e791151c8056e0f10e7245e26043496ee6be2e151",
"md5": "aa248c4577399c99c2f22a0d70399686",
"sha256": "d9ad06c958f88ce8406818b68e1b6c78d514144199214d01be787951fd442a9d"
},
"downloads": -1,
"filename": "qctrl_sphinx_theme-2.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa248c4577399c99c2f22a0d70399686",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 531788,
"upload_time": "2023-11-27T00:21:55",
"upload_time_iso_8601": "2023-11-27T00:21:55.396649Z",
"url": "https://files.pythonhosted.org/packages/48/19/45f68a68e250620ea64e791151c8056e0f10e7245e26043496ee6be2e151/qctrl_sphinx_theme-2.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "057ec86e95bb6cafb664fa5e6fcfa0834e9351f8724d6993126e8161ee8e7f8f",
"md5": "287d11abc20a93e0160ab462e44531a7",
"sha256": "d5ccf2d7e582be2555b57a277dcea401e69cd25aca23391338f9abc48f287a72"
},
"downloads": -1,
"filename": "qctrl_sphinx_theme-2.1.4.tar.gz",
"has_sig": false,
"md5_digest": "287d11abc20a93e0160ab462e44531a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 528419,
"upload_time": "2023-11-27T00:21:57",
"upload_time_iso_8601": "2023-11-27T00:21:57.035848Z",
"url": "https://files.pythonhosted.org/packages/05/7e/c86e95bb6cafb664fa5e6fcfa0834e9351f8724d6993126e8161ee8e7f8f/qctrl_sphinx_theme-2.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 00:21:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "qctrl-sphinx-theme"
}
JSON