Skip to content

Commit

Permalink
docs: port docs source to markdown, fix links (#522)
Browse files Browse the repository at this point in the history
* port to markdown, fix links

* fix some formatting

* fix a typo

* more formatting

* update .gitignore

* replace old tket.quantinuum links
  • Loading branch information
CalMacCQ authored Oct 23, 2024
1 parent b09209c commit 518a12e
Show file tree
Hide file tree
Showing 21 changed files with 794 additions and 803 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ pytket/extensions/quantinuum/_metadata.py
.DS_Store
docs/pyproject.toml
docs/poetry.lock
.jupyter_cache/
jupyter_execute/
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://tketusers.slack.com/join/shared_invite/zt-18qmsamj9-UqQFVdkRzxnXCcKtcarLRA#)
[![Stack Exchange](https://img.shields.io/badge/StackExchange-%23ffffff.svg?style=for-the-badge&logo=StackExchange)](https://quantumcomputing.stackexchange.com/tags/pytket)

[Pytket](https://tket.quantinuum.com/api-docs/index.html) is a python module for interfacing
[Pytket](https://docs.quantinuum.com/tket/api-docs/index.html) is a python module for interfacing
with tket, a quantum computing toolkit and optimising compiler developed by Quantinuum.

`pytket-quantinuum` is an extension to `pytket` that allows `pytket` circuits to
be executed on Quantinuum's quantum devices.

Some useful links:
- [API Documentation](https://tket.quantinuum.com/extensions/pytket-quantinuum/)
- [API Documentation](https://docs.quantinuum.com/tket/extensions/pytket-quantinuum/)

## Getting started

Expand Down
31 changes: 26 additions & 5 deletions docs/api.rst → docs/api.md
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:
```
Loading

0 comments on commit 518a12e

Please sign in to comment.