Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Link to home page in TOC and update extensions #1139

Closed
wants to merge 4 commits into from
Closed

Link to home page in TOC and update extensions #1139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16c8df2
add self to TOC tree
CalMacCQ Nov 22, 2023
434731c
call page API docs home
CalMacCQ Nov 22, 2023
ca326d3
mention qulacs densitry matrix simulation
CalMacCQ Nov 22, 2023
603a8e5
minor edits
CalMacCQ Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion pytket/docs/extensions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@ Density Matrix Simulators
`CirqDensityMatrixSimBackend <https://tket.quantinuum.com/extensions/pytket-cirq/api.html#pytket.extensions.cirq.CirqDensityMatrixSimBackend>`_
- Backend for Cirq density matrix simulator density_matrix return.

`QulacsBackend`_ - This has a configurable density matrix simulation option.

Use ``QulacsBackend(result_type="density_matrix")``.

Clifford Simulators
-------------------

Expand Down Expand Up @@ -156,4 +160,5 @@ Other
.. _ForestStateBackend: https://tket.quantinuum.com/extensions/pytket-pyquil/api/api.html#pytket.extensions.pyquil.ForestStateBackend
.. _AerUnitaryBackend: https://tket.quantinuum.com/extensions/pytket-qiskit/api/api.html#pytket.extensions.qiskit.AerUnitaryBackend
.. _CirqDensityMatrixSampleBackend: https://tket.quantinuum.com/extensions/pytket-cirq/api/api.html#pytket.extensions.cirq.CirqDensityMatrixSampleBackend
.. _SimplexBackend: https://tket.quantinuum.com/extensions/pytket-simplex/api.html#pytket.extensions.pysimplex.SimplexBackend
.. _SimplexBackend: https://tket.quantinuum.com/extensions/pytket-simplex/api.html#pytket.extensions.pysimplex.SimplexBackend
.. _QulacsBackend: https://tket.quantinuum.com/extensions/pytket-qulacs/api.html#pytket.extensions.qulacs.QulacsBackend
5 changes: 3 additions & 2 deletions pytket/docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,19 @@ Licensed under the `Apache 2 License <http://www.apache.org/licenses/LICENSE-2.0
.. _Quantinuum: https://www.quantinuum.com/

.. toctree::
:caption: Introduction:
:caption: Overview:
:maxdepth: 1

API docs home <self>
getting_started.rst
changelog.rst
install.rst
TKET website <https://tket.quantinuum.com/>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we not adding extension, examples and manual to this overview?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think its more apporiate to merge the "Overview" and "More documentation" lists?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but if you have good reasons to not do that, I am happy to discuss that. But I am not sure what our general plan is how and if we want to add the general navigation bar on top?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking we add these links here as an easy near term solution and then figure out the navbar later on.

faqs.rst

.. toctree::
:caption: More Documentation:

TKET website <https://tket.quantinuum.com/>
Manual <https://tket.quantinuum.com/user-manual/>
extensions.rst
Example notebooks <https://tket.quantinuum.com/examples>
Expand Down
Loading