Skip to main content

Sphinx tools for OpenQASM programs

Project description

Sphinx tools for OpenQASM

LicenseReleaseDownloads

This repository provides the Python package openqasm-sphinx, which provides a Sphinx extension for documentation OpenQASM 2 and 3 code.

Installation and use

Install the latest release of openqasm-sphinx package from pip:

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:

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.

Set up your development environment by installing the development requirements with pip:

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

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. This is a Qiskit project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openqasm-sphinx-0.1.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

openqasm_sphinx-0.1.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file openqasm-sphinx-0.1.0.tar.gz.

File metadata

  • Download URL: openqasm-sphinx-0.1.0.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for openqasm-sphinx-0.1.0.tar.gz
Algorithm Hash digest
SHA256 33dbfdbf74d73d87e1afe8055f00351d89f955d6cf45c310ddb44b68d830a998
MD5 97cc92e49261ae707770dba5a5944330
BLAKE2b-256 7c82e8e9cc5d472cc8b814263fcad0339714455f312584f0875275ee0d52445c

See more details on using hashes here.

Provenance

File details

Details for the file openqasm_sphinx-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for openqasm_sphinx-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d8ec847fa72dcb59009b637961a5dc78b4188d6ac741ba116225fef498567b4
MD5 4cf474e208a9687319f6d6da892b1663
BLAKE2b-256 d7f1d328d722eb8adf60df065106c7fec7301efa6dce98ffd4a51ee9175b9162

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page