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.

Sign up for GitHub

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
Open

Add containers docs #13564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4439e7b
add containers docs
samanthavbarron Dec 13, 2024
e51f4a2
reno
samanthavbarron Dec 13, 2024
b5adfa0
Update releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml
samanthavbarron Dec 16, 2024
87cff0d
Merge branch 'main' into add-containers-docs
samanthavbarron Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions qiskit/primitives/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,24 @@
BackendSampler
SamplerResult


Containers
----------

.. 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.

DataBin
PrimitiveResult
PubResult
EstimatorPubLike
SamplerPubLike
SamplerPubResult
BindingsArrayLike
ObservableLike
ObservablesArrayLike

"""

from .backend_estimator import BackendEstimator
Expand Down
4 changes: 4 additions & 0 deletions releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
other:
- |
Added documentation for `BitArray`, `DataBin`, `PrimitiveResult`, `PubResult`, `EstimatorPubLike`, `SamplerPubLike`, `SamplerPubResult`, `BindingsArrayLike`, `ObservableLike`, and `ObservablesArrayLike`.
Loading