-
Notifications
You must be signed in to change notification settings - Fork 14
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, fix links (#522)
* port to markdown, fix links * fix some formatting * fix a typo * more formatting * update .gitignore * replace old tket.quantinuum links
- Loading branch information
Showing
21 changed files
with
794 additions
and
803 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,41 +1,62 @@ | ||
API documentation | ||
~~~~~~~~~~~~~~~~~ | ||
# API documentation | ||
|
||
The pytket-quantinuum extension allows submission of pytket circuits to the H-series trapped ion devices (and emulators) via the :py:class:`QuantinuumBackend`. | ||
The pytket-quantinuum extension allows submission of pytket circuits to the H-series trapped ion devices (and emulators) via the {py:class}`QuantinuumBackend`. | ||
|
||
Consult the `notebooks <https://github.com/CQCL/pytket-quantinuum/tree/develop/examples>`_ for some example usage. | ||
Consult the [notebooks](https://github.com/CQCL/pytket-quantinuum/tree/develop/examples) for some example usage. | ||
|
||
```{eval-rst} | ||
.. currentmodule:: pytket.extensions.quantinuum | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoenum:: Language | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: QuantinuumBackend | ||
:show-inheritance: | ||
:special-members: __init__ | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: QuantinuumBackendCompilationConfig | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: QuantinuumAPI | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: QuantinuumAPIOffline | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. automodule:: pytket.extensions.quantinuum.backends.config | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. automodule:: pytket.extensions.quantinuum.backends.leakage_gadget | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.quantinuum.backends.credential_storage.CredentialStorage | ||
:special-members: __init__ | ||
:members: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.quantinuum.backends.credential_storage.MemoryCredentialStorage | ||
:show-inheritance: | ||
``` | ||
|
||
```{eval-rst} | ||
.. autoclass:: pytket.extensions.quantinuum.backends.credential_storage.QuantinuumConfigCredentialStorage | ||
:show-inheritance: | ||
:show-inheritance: | ||
``` |
Oops, something went wrong.