Skip to content

Commit

Permalink
docs: fix autosummary table alignment on docs page (#393)
Browse files Browse the repository at this point in the history
* fix: align autosummary tables better

* fix: update variable name in code snippet

* fix: TketBackend cross-ref

* fix: use ..currentmodule:: directive

* remove duplicate
  • Loading branch information
CalMacCQ authored Sep 18, 2024
1 parent 47520d8 commit c2ff1e7
Showing 1 changed file with 7 additions and 19 deletions.
26 changes: 7 additions & 19 deletions docs/intro.txt
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

0 comments on commit c2ff1e7

Please sign in to comment.