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

docs: fix autosummary table alignment on docs page #393

Merged
merged 5 commits into from
Sep 18, 2024
Merged

docs: fix autosummary table alignment on docs page #393

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
15e85ba
fix: align autosummary tables better
CalMacCQ Sep 17, 2024
6d231fe
fix: update variable name in code snippet
CalMacCQ Sep 17, 2024
70e3e0c
fix: TketBackend cross-ref
CalMacCQ Sep 17, 2024
e89cfc3
fix: use ..currentmodule:: directive
CalMacCQ Sep 17, 2024
fb09c68
remove duplicate
CalMacCQ Sep 17, 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
26 changes: 7 additions & 19 deletions docs/intro.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ To see which devices you can access, use the :py:meth:`IBMQBackend.available_dev

backend = IBMQBackend("ibm_kyiv") # Initialise backend for an IBM device

backendinfo_list = backend.available_devices(instance=my_instance)
backendinfo_list = backend.available_devices(instance=inst)
print([backend.device_name for backend in backendinfo_list])

For more information, see the documentation for `qiskit-ibm-runtime <https://docs.quantum.ibm.com/api/qiskit-ibm-runtime>`_.
Expand Down Expand Up @@ -215,30 +215,18 @@ Noise Modelling

Using TKET directly on qiskit circuits
======================================
.. currentmodule:: pytket.extensions.qiskit

For usage of :py:class:`~pytket.extensions.qiskit.TketBackend` see the `qiskit integration notebook example <https://tket.quantinuum.com/examples/qiskit_integration.html>`_.

.. currentmodule:: pytket.extensions.qiskit.tket_backend

.. autosummary::
:nosignatures:

TketBackend

.. currentmodule:: pytket.extensions.qiskit.tket_pass
For usage of :py:class:`~tket_backend.TketBackend` see the `qiskit integration notebook example <https://tket.quantinuum.com/examples/qiskit_integration.html>`_.

.. autosummary::
:nosignatures:

TketPass
TketAutoPass

.. currentmodule:: pytket.extensions.qiskit.tket_job

.. autosummary::
:nosignatures:
~tket_backend.TketBackend
~tket_pass.TketPass
~tket_pass.TketAutoPass
~tket_job.TketJob

TketJob


.. toctree::
Expand Down