Sphinx工具用于OpenQASM

此存储库提供了Python包openqasm-sphinx，该包提供用于文档OpenQASM 2和3代码的Sphinx扩展。

安装和使用

从pip安装openqasm-sphinx包的最新版本

pip install openqasm-sphinx

如果尚未安装，这将自动安装所有依赖项（例如Sphinx）。

要激活扩展，请将openqasm_sphinx添加到Sphinx的conf.py文件中的extensions列表中，例如

project = "My Project"
author = "Me"
version = "1.0"

extensions = [
    "openqasm_sphinx",
]

无需导入扩展；Sphinx将自动处理。

开发

如果您想为此项目做出贡献，请首先阅读我们的贡献指南。

通过使用pip安装开发需求来设置您的开发环境

pip install -r requirements-dev.txt tox

这会安装比运行时包依赖项更多的几个包。

在开发需求安装完成后，您可以使用以下命令安装可编辑版本的软件包：

pip install -e .

之后，您对库代码所做的任何更改，在您打开一个新的Python解释器会话或构建一个依赖于此项目的Sphinx项目时，都会立即生效。

许可协议

本项目采用Apache License 2.0授权。这是一个Qiskit项目。