Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add exceptions to API documentation (backport #10522) #10628

Merged
merged 2 commits into from
Aug 15, 2023

Commits on Aug 14, 2023

  1. Add exceptions to API documentation (#10522)

    The big change here is that `QiskitError` is added to the API
    documentation, which causes 400--500 previously failing Sphinx lookups
    (stemming from "Raises:" documentation) to now succeed.  This commit
    also corrects several other places where exceptions were not being fully
    documented (and in several cases makes the imports more convenient as
    well), and corrects a couple of places with incorrect references to
    exceptions.
    
    (cherry picked from commit 982807e)
    
    # Conflicts:
    #	docs/apidocs/exceptions.rst
    #	qiskit/dagcircuit/__init__.py
    #	qiskit/passmanager/__init__.py
    #	qiskit/transpiler/__init__.py
    jakelishman authored and mergify[bot] committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    9412a53 View commit details
    Browse the repository at this point in the history

Commits on Aug 15, 2023

  1. Fix merge conflicts

    This commit fixes several merge conflicts in the backport. They were
    mostly minor differences between main and the stable branch that needed
    to be corrected.
    mtreinish committed Aug 15, 2023
    Configuration menu
    Copy the full SHA
    e883dca View commit details
    Browse the repository at this point in the history