Skip to content

Commit

Permalink
docs: port docs source to markdown, update all links (#405)
Browse files Browse the repository at this point in the history
* 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
CalMacCQ authored Oct 25, 2024
1 parent 64da26f commit b332fbf
Show file tree
Hide file tree
Showing 11 changed files with 678 additions and 667 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ pytket/extensions/qiskit/_metadata.py
*.ipynb
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,15 +3,15 @@
[![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-qiskit` is an extension to `pytket` that allows `pytket` circuits to be
run on IBM backends and simulators, as well as conversion to and from Qiskit
representations.

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

## Getting started

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

0 comments on commit b332fbf

Please sign in to comment.