# Sphinx tools for OpenQASM
[](https://opensource.org/licenses/Apache-2.0)[](https://github.com/openqasm/openqasm-sphinx/releases)[](https://pypi.org/project/openqasm-sphinx/)
This repository provides the Python package `openqasm-sphinx`, which provides a [Sphinx extension](https://www.sphinx-doc.org) for documentation OpenQASM 2 and 3 code.
## Installation and use
Install the latest release of `openqasm-sphinx` package from pip:
```bash
pip install openqasm-sphinx
```
This will automatically install all the dependencies as well (Sphinx, for example) if they are not already installed.
To activate the extension add `openqasm_sphinx` to your `extensions` list in your Sphinx `conf.py` file, such as:
```python
project = "My Project"
author = "Me"
version = "1.0"
extensions = [
"openqasm_sphinx",
]
```
There is no need to import the extension; Sphinx will ahndle this automatically.
## Developing
If you're looking to contribute to this project, please first read [our contributing guidelines](CONTRIBUTING.md).
Set up your development environment by installing the development requirements with pip:
```bash
pip install -r requirements-dev.txt tox
```
This installs a few more packages than the dependencies of the package at runtime.
After the development requirements are installed, you can install an editable version of the package with
```bash
pip install -e .
```
After this, any changes you make to the library code will immediately be present when you open a new Python interpreter session, or build a Sphinx project that depends on this project.
## License
This project is licensed under [version 2.0 of the Apache License](LICENSE).
This is a Qiskit project.
Raw data
{
"_id": null,
"home_page": null,
"name": "openqasm-sphinx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "openqasm, quantum programming language, documentation, Sphinx",
"author": "OpenQASM contributors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7c/82/e8e9cc5d472cc8b814263fcad0339714455f312584f0875275ee0d52445c/openqasm-sphinx-0.1.0.tar.gz",
"platform": null,
"description": "# Sphinx tools for OpenQASM\n\n[](https://opensource.org/licenses/Apache-2.0)[](https://github.com/openqasm/openqasm-sphinx/releases)[](https://pypi.org/project/openqasm-sphinx/)\n\nThis repository provides the Python package `openqasm-sphinx`, which provides a [Sphinx extension](https://www.sphinx-doc.org) for documentation OpenQASM 2 and 3 code.\n\n\n## Installation and use\n\nInstall the latest release of `openqasm-sphinx` package from pip:\n\n```bash\npip install openqasm-sphinx\n```\n\nThis will automatically install all the dependencies as well (Sphinx, for example) if they are not already installed.\n\nTo activate the extension add `openqasm_sphinx` to your `extensions` list in your Sphinx `conf.py` file, such as:\n\n```python\nproject = \"My Project\"\nauthor = \"Me\"\nversion = \"1.0\"\n\nextensions = [\n \"openqasm_sphinx\",\n]\n```\n\nThere is no need to import the extension; Sphinx will ahndle this automatically.\n\n\n## Developing\n\nIf you're looking to contribute to this project, please first read [our contributing guidelines](CONTRIBUTING.md).\n\nSet up your development environment by installing the development requirements with pip:\n\n```bash\npip install -r requirements-dev.txt tox\n```\n\nThis installs a few more packages than the dependencies of the package at runtime.\n\nAfter the development requirements are installed, you can install an editable version of the package with\n\n```bash\npip install -e .\n```\n\nAfter this, any changes you make to the library code will immediately be present when you open a new Python interpreter session, or build a Sphinx project that depends on this project.\n\n\n## License\n\nThis project is licensed under [version 2.0 of the Apache License](LICENSE).\nThis is a Qiskit project.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Sphinx tools for OpenQASM programs",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"openqasm",
" quantum programming language",
" documentation",
" sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7f1d328d722eb8adf60df065106c7fec7301efa6dce98ffd4a51ee9175b9162",
"md5": "4cf474e208a9687319f6d6da892b1663",
"sha256": "8d8ec847fa72dcb59009b637961a5dc78b4188d6ac741ba116225fef498567b4"
},
"downloads": -1,
"filename": "openqasm_sphinx-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4cf474e208a9687319f6d6da892b1663",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9446,
"upload_time": "2024-04-09T14:46:42",
"upload_time_iso_8601": "2024-04-09T14:46:42.355480Z",
"url": "https://files.pythonhosted.org/packages/d7/f1/d328d722eb8adf60df065106c7fec7301efa6dce98ffd4a51ee9175b9162/openqasm_sphinx-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c82e8e9cc5d472cc8b814263fcad0339714455f312584f0875275ee0d52445c",
"md5": "97cc92e49261ae707770dba5a5944330",
"sha256": "33dbfdbf74d73d87e1afe8055f00351d89f955d6cf45c310ddb44b68d830a998"
},
"downloads": -1,
"filename": "openqasm-sphinx-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "97cc92e49261ae707770dba5a5944330",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9276,
"upload_time": "2024-04-09T14:46:43",
"upload_time_iso_8601": "2024-04-09T14:46:43.823233Z",
"url": "https://files.pythonhosted.org/packages/7c/82/e8e9cc5d472cc8b814263fcad0339714455f312584f0875275ee0d52445c/openqasm-sphinx-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 14:46:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "openqasm-sphinx"
}
JSON