{"id":20779743,"url":"https://github.com/openqasm/openqasm-sphinx","last_synced_at":"2025-12-25T05:33:11.997Z","repository":{"id":232400792,"uuid":"783802486","full_name":"openqasm/openqasm-sphinx","owner":"openqasm","description":"Sphinx extension for documenting OpenQASM","archived":false,"fork":false,"pushed_at":"2024-04-09T17:09:03.000Z","size":133,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-14T20:37:03.098Z","etag":null,"topics":["documentation","openqasm","quantum-programming-language","sphinx"],"latest_commit_sha":null,"homepage":"https://openqasm.com/openqasm-sphinx","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openqasm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-04-08T15:45:51.000Z","updated_at":"2024-04-09T17:56:57.000Z","dependencies_parsed_at":"2024-04-09T17:51:44.356Z","dependency_job_id":"2b5f1a17-bd55-4d8d-86f8-dade94ffffaa","html_url":"https://github.com/openqasm/openqasm-sphinx","commit_stats":null,"previous_names":["openqasm/openqasm-sphinx"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openqasm%2Fopenqasm-sphinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openqasm%2Fopenqasm-sphinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openqasm%2Fopenqasm-sphinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openqasm%2Fopenqasm-sphinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openqasm","download_url":"https://codeload.github.com/openqasm/openqasm-sphinx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243120416,"owners_count":20239469,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","openqasm","quantum-programming-language","sphinx"],"created_at":"2024-11-17T13:29:27.725Z","updated_at":"2025-12-25T05:33:11.948Z","avatar_url":"https://github.com/openqasm.png","language":"Python","readme":"# Sphinx tools for OpenQASM\n\n[![License](https://img.shields.io/github/license/openqasm/openqasm-sphinx.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0)[![Release](https://img.shields.io/github/release/openqasm/openqasm-sphinx.svg?style=popout-square)](https://github.com/openqasm/openqasm-sphinx/releases)[![Downloads](https://img.shields.io/pypi/dm/openqasm-sphinx.svg?style=popout-square)](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\nThe documentation is hosted at https://openqasm.com/openqasm-sphinx.\n\n\n## Installation\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\n## Use\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 handle this automatically.\n\nDocument a gate by doing:\n\n```rst\n\n.. oq:gate:: my_gate(θ) a, b\n\n    This is my gate.\n```\n\nand later insert a cross-reference to it in inline text with:\n\n```rst\nFor more information, see :oq:gate:`my_gate`.\n```\n\nIf you are set `primary_domain = \"oq\"` in your Sphinx configuration, you can drop the `oq` prefixes.\n\nFor more complete usage information, see [the rendered documentation](https://openqasm.com/openqasm-sphinx).\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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenqasm%2Fopenqasm-sphinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenqasm%2Fopenqasm-sphinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenqasm%2Fopenqasm-sphinx/lists"}