occheung
/
artiq
forked from M-Labs/artiq
1
0
Fork 0
Code Pull Requests Activity

doc: Split running/management tool reference into separate page

This commit is contained in:
architeuthis 2024-06-25 12:06:18 +08:00 committed by Sébastien Bourdeauducq
parent 0dc727c1fd
commit de1df88dcd
4 changed files with 50 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/manual/index.rst
View File

@ -18,6 +18,7 @@ ARTIQ documentation
management_system management_system
drtio drtio
core_device core_device
main_frontend_reference
core_language_reference core_language_reference
core_drivers_reference core_drivers_reference
utilities utilities

47
doc/manual/main_frontend_reference.rst Normal file
View File

@ -0,0 +1,47 @@
Main front-end tool reference
=============================
These are the top-level commands used to run and manage ARTIQ experiments. Not all of the ARTIQ front-end is described here (many additional useful commands are presented in this manual in :doc:`utilities`) but these together comprise the main points of access for using ARTIQ as a system.
:mod:`artiq.frontend.artiq_run`
-------------------------------
.. argparse::
:ref: artiq.frontend.artiq_run.get_argparser
:prog: artiq_run
.. _frontend-artiq-master:
:mod:`artiq.frontend.artiq_master`
----------------------------------
.. argparse::
:ref: artiq.frontend.artiq_master.get_argparser
:prog: artiq_master
.. _frontend-artiq-client:
:mod:`artiq.frontend.artiq_client`
----------------------------------
.. argparse::
:ref: artiq.frontend.artiq_client.get_argparser
:prog: artiq_client
.. _frontend-artiq-dashboard:
:mod:`artiq.frontend.artiq_dashboard`
-------------------------------------
.. argparse::
:ref: artiq.frontend.artiq_dashboard.get_argparser
:prog: artiq_dashboard
:mod:`artiq.frontend.artiq_session`
-----------------------------------
.. argparse::
:ref: artiq.frontend.artiq_session.get_argparser
:prog: artiq_session

40
doc/manual/management_system.rst
View File

@ -196,43 +196,3 @@ The `EntryArea` object can then be added to a layout and integrated with the app
Set multiple values from a dictionary input. Calls ``set_value()`` for each key-value pair. Set multiple values from a dictionary input. Calls ``set_value()`` for each key-value pair.
:param values: Dictionary with names as keys and new argument values as values. :param values: Dictionary with names as keys and new argument values as values.
Front-end tool reference
------------------------
.. _frontend-artiq-master:
artiq_master
^^^^^^^^^^^^
.. argparse::
:ref: artiq.frontend.artiq_master.get_argparser
:prog: artiq_master
.. _frontend-artiq-client:
artiq_client
^^^^^^^^^^^^
.. argparse::
:ref: artiq.frontend.artiq_client.get_argparser
:prog: artiq_client
.. _frontend-artiq-dashboard:
artiq_dashboard
^^^^^^^^^^^^^^^
.. argparse::
:ref: artiq.frontend.artiq_dashboard.get_argparser
:prog: artiq_dashboard
artiq_session
^^^^^^^^^^^^^
.. argparse::
:ref: artiq.frontend.artiq_session.get_argparser
:prog: artiq_session

8
doc/manual/utilities.rst
View File

@ -4,14 +4,6 @@ Utilities
.. Sort these tool by some subjective combination of their .. Sort these tool by some subjective combination of their
typical sequence and expected frequency of use. typical sequence and expected frequency of use.
Local running tool
------------------
.. argparse::
:ref: artiq.frontend.artiq_run.get_argparser
:prog: artiq_run
Static compiler Static compiler
--------------- ---------------