From c2ff1e76cae71eb1e4c2fb9dae6545afbac949e9 Mon Sep 17 00:00:00 2001 From: Callum Macpherson <93673602+CalMacCQ@users.noreply.github.com> Date: Wed, 18 Sep 2024 10:03:26 +0100 Subject: [PATCH] docs: fix autosummary table alignment on docs page (#393) * fix: align autosummary tables better * fix: update variable name in code snippet * fix: TketBackend cross-ref * fix: use ..currentmodule:: directive * remove duplicate --- docs/intro.txt | 26 +++++++------------------- 1 file changed, 7 insertions(+), 19 deletions(-) diff --git a/docs/intro.txt b/docs/intro.txt index 8dedfa0c..ce8a42a3 100644 --- a/docs/intro.txt +++ b/docs/intro.txt @@ -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 `_. @@ -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 `_. - -.. 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 `_. .. 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::