Skip to content

Commit c2ff1e7

Browse files
authored
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
1 parent 47520d8 commit c2ff1e7

File tree

1 file changed

+7
-19
lines changed

1 file changed

+7
-19
lines changed

docs/intro.txt

+7-19
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To see which devices you can access, use the :py:meth:`IBMQBackend.available_dev
104104

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

107-
backendinfo_list = backend.available_devices(instance=my_instance)
107+
backendinfo_list = backend.available_devices(instance=inst)
108108
print([backend.device_name for backend in backendinfo_list])
109109

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

216216
Using TKET directly on qiskit circuits
217217
======================================
218+
.. currentmodule:: pytket.extensions.qiskit
218219

219-
For usage of :py:class:`~pytket.extensions.qiskit.TketBackend` see the `qiskit integration notebook example <https://tket.quantinuum.com/examples/qiskit_integration.html>`_.
220-
221-
.. currentmodule:: pytket.extensions.qiskit.tket_backend
222-
223-
.. autosummary::
224-
:nosignatures:
225-
226-
TketBackend
227-
228-
.. currentmodule:: pytket.extensions.qiskit.tket_pass
220+
For usage of :py:class:`~tket_backend.TketBackend` see the `qiskit integration notebook example <https://tket.quantinuum.com/examples/qiskit_integration.html>`_.
229221

230222
.. autosummary::
231223
:nosignatures:
232224

233-
TketPass
234-
TketAutoPass
235-
236-
.. currentmodule:: pytket.extensions.qiskit.tket_job
237-
238-
.. autosummary::
239-
:nosignatures:
225+
~tket_backend.TketBackend
226+
~tket_pass.TketPass
227+
~tket_pass.TketAutoPass
228+
~tket_job.TketJob
240229

241-
TketJob
242230

243231

244232
.. toctree::

0 commit comments

Comments
 (0)