-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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 containers docs #13564
base: main
Are you sure you want to change the base?
Add containers docs #13564
Conversation
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the following people are relevant to this code:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you remind me if there's an easy way to see a render preview?
Pull Request Test Coverage Report for Build 12357286611Details
💛 - Coveralls |
I'm not sure, I'll poke around and see if GH Actions stores it somewhere. If so I'll post a screenshot |
Co-authored-by: Ian Hincks <ian.hincks@gmail.com>
@samanthavbarron the docs are available as build artifact in the lint + docs stage, but it seems they currently fail to build. You can also build them locally via |
.. autosummary:: | ||
:toctree: ../stubs/ | ||
|
||
BitArray |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will fail because the indentation level for Bitarray
etc. is not the same as for :toctree:
. Shpinx is very strict regarding the "same-indentation" policy for anything below a ..
block.
You can check it worked locally using tox -edocs
.
Summary
This PR builds the documentation for the containers defined in
qiskit.primitives.containers
.Closes: Qiskit/documentation#2475
Details and comments