Skip to content

Commit 4ae33a7

Browse files
khalatepradnyaefratshabtai
authored andcommitted
[docs] Miscellaneous fixes to improve cross-linking (#4122)
This PR improves the documentation by adding references to complete usage examples and listing aggregators under the hardware backends. --------- Signed-off-by: Pradnya Khalate <pkhalate@nvidia.com> Signed-off-by: Pradnya Khalate <148914294+khalatepradnya@users.noreply.github.com> Co-authored-by: efratshabtai <efratshabtai@users.noreply.github.com>
1 parent cb45f75 commit 4ae33a7

File tree

3 files changed

+22
-9
lines changed

3 files changed

+22
-9
lines changed

docs/sphinx/using/backends/cloud/scaleway.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,6 @@ or do it by calling the Scaleway's QaaS API:
133133
134134
# Terminate the session
135135
curl -X POST -H "X-Auth-Token: $SCW_SECRET_KEY" -H "Content-Type: application/json" "https://api.scaleway.com/qaas/v1alpha1/sessions/{session_id}/terminate"
136+
137+
138+
To see a complete example, take a look at :ref:`Scaleway QaaS examples <scaleway-examples>`.

docs/sphinx/using/backends/hardware.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,9 @@ To submit to a hardware backend, you need an account with the respective provide
1616
Neutral Atom QPUs <hardware/neutralatom.rst>
1717
Photonic QPUs <hardware/photonic.rst>
1818
Quantum Control Systems <hardware/qcontrol.rst>
19+
20+
- :doc:`Cloud <cloud>`
21+
22+
- :doc:`Amazon Braket <cloud/braket>`
23+
24+
- :doc:`Scaleway QaaS <cloud/scaleway>`

docs/sphinx/using/backends/hardware/superconducting.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -520,15 +520,6 @@ Submitting
520520
To see a complete example of using Quantum Circuits' backends, please take a look at the
521521
:ref:`Quantum Circuits examples <quantum-circuits-examples>`.
522522

523-
.. note::
524-
525-
In local emulation mode (``emulate`` flag set to ``True``), the program will be executed on the :ref:`default simulator <default-simulator>`.
526-
The environment variable ``CUDAQ_DEFAULT_SIMULATOR`` can be used to change the emulation simulator.
527-
528-
For example, the simulation floating point accuracy and/or the simulation capabilities (e.g., maximum number of qubits, supported quantum gates),
529-
depend on the selected simulator.
530-
531-
Any environment variables must be set prior to setting the target or running "`import cudaq`".
532523

533524
TII
534525
+++
@@ -596,3 +587,16 @@ Submitting jobs
596587
nvq++ --target tii --tii-device tii-sim --tii-project personal main.cpp -o main.x
597588
598589
The ``TII_API_TOKEN`` environment variable must be set at runtime to authenticate the job.
590+
591+
To see a complete example of using TII's backends, please take a look at the :ref:`TII examples <tii-examples>`.
592+
593+
594+
.. note::
595+
596+
In local emulation mode (``emulate`` flag set to ``True``), the program will be executed on the :ref:`default simulator <default-simulator>`.
597+
The environment variable ``CUDAQ_DEFAULT_SIMULATOR`` can be used to change the emulation simulator.
598+
599+
For example, the simulation floating point accuracy and/or the simulation capabilities (e.g., maximum number of qubits, supported quantum gates),
600+
depend on the selected simulator.
601+
602+
Any environment variables must be set prior to setting the target or running `import cudaq`.

0 commit comments

Comments
 (0)