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 containers docs #13564

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

samanthavbarron
Copy link
Contributor

Summary

This PR builds the documentation for the containers defined in qiskit.primitives.containers.

Closes: Qiskit/documentation#2475

Details and comments

@samanthavbarron samanthavbarron requested review from a team as code owners December 13, 2024 16:15
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Dec 13, 2024
@qiskit-bot
Copy link
Collaborator

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:

  • @Qiskit/terra-core
  • @ajavadia
  • @levbishop
  • @t-imamichi

Copy link
Contributor

@ihincks ihincks left a 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?

@coveralls
Copy link

coveralls commented Dec 13, 2024

Pull Request Test Coverage Report for Build 12357286611

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 10 unchanged lines in 3 files lost coverage.
  • Overall coverage decreased (-0.008%) to 88.953%

Files with Coverage Reduction New Missed Lines %
crates/accelerate/src/unitary_synthesis.rs 1 92.2%
crates/qasm2/src/expr.rs 1 94.02%
crates/qasm2/src/lex.rs 8 91.98%
Totals Coverage Status
Change from base Build 12356117829: -0.008%
Covered Lines: 79419
Relevant Lines: 89282

💛 - Coveralls

@samanthavbarron
Copy link
Contributor Author

Can you remind me if there's an easy way to see a render preview?

I'm not sure, I'll poke around and see if GH Actions stores it somewhere. If so I'll post a screenshot

@Cryoris
Copy link
Contributor

Cryoris commented Dec 17, 2024

@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 tox -e docs (maybe with a prior tox -e docs-clean 🙂).

.. autosummary::
:toctree: ../stubs/

BitArray
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community PR PRs from contributors that are not 'members' of the Qiskit repo
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

qiskit.primitives.containers classes not built in docs
6 participants