Qiskit / qiskit-metapackage

Qiskit is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.
https://qiskit.org
Apache License 2.0
3.03k stars 749 forks source link

Rewrite Maintainer's Guide to use Docs Guide & mention metapackage migration #1745

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

Originally, I was trying to fix an issue from Sphinx that it was trying to evaluate the directives inside our code block of example docstring.

WARNING: [autosummary] failed to import qiskit.dagcircuit.Exceptions.
Possible hints:
* ModuleNotFoundError: No module named 'qiskit.dagcircuit.Exceptions'
* ImportError: 
* AttributeError: module 'qiskit.dagcircuit' has no attribute 'Exceptions'

I could not figure out how to fix that.

Instead, I realized we should be pointing to https://qiskit.github.io/qiskit_sphinx_theme/apidocs/index.html. We are currently duplicating docs we already wrote specifically for this context.

--

Likewise, this refreshes the explanation of the metapackage repo.