-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: port docs source to markdown, update all links (#405)
* port source files to markdown * clean up links in table * update ibm sentance * use mystnb code cells * update .gitignore * update all remaining tket.quantinuum.com links * fix invalid table * fix TketBackend links * update theming submodule * update table heading * delete duplicate changelog * update markdown changelog * fix accidental changes to ibm.py * fix a link * use latest submodule version
- Loading branch information
Showing
11 changed files
with
678 additions
and
667 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,78 @@ | ||
API documentation | ||
~~~~~~~~~~~~~~~~~ | ||
# API documentation | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.qiskit.IBMQBackend | ||
:special-members: __init__ | ||
:show-inheritance: | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.qiskit.IBMQEmulatorBackend | ||
:special-members: __init__ | ||
:show-inheritance: | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.qiskit.AerBackend | ||
:special-members: __init__ | ||
:inherited-members: | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.qiskit.AerStateBackend | ||
:special-members: __init__ | ||
:inherited-members: | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.qiskit.AerUnitaryBackend | ||
:special-members: __init__ | ||
:inherited-members: | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.qiskit.AerDensityMatrixBackend | ||
:special-members: __init__ | ||
:inherited-members: | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. automodule:: pytket.extensions.qiskit | ||
:members: qiskit_to_tk, tk_to_qiskit, process_characterisation | ||
``` | ||
|
||
```{eval-rst} | ||
.. automodule:: pytket.extensions.qiskit.tket_backend | ||
:show-inheritance: | ||
:members: | ||
:special-members: __init__ | ||
``` | ||
|
||
```{eval-rst} | ||
.. automodule:: pytket.extensions.qiskit.backends.crosstalk_model | ||
:members: CrosstalkParams | ||
``` | ||
|
||
```{eval-rst} | ||
.. automodule:: pytket.extensions.qiskit.tket_pass | ||
:special-members: __init__ | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. automodule:: pytket.extensions.qiskit.tket_job | ||
:special-members: __init__ | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. automodule:: pytket.extensions.qiskit.backends.config | ||
:members: | ||
``` |
Oops, something went wrong.