From de1df88dcd0523906e231cb35a604043b70f62aa Mon Sep 17 00:00:00 2001 From: architeuthis Date: Tue, 25 Jun 2024 12:06:18 +0800 Subject: [PATCH] doc: Split running/management tool reference into separate page --- doc/manual/index.rst | 1 + doc/manual/main_frontend_reference.rst | 47 ++++++++++++++++++++++++++ doc/manual/management_system.rst | 42 +---------------------- doc/manual/utilities.rst | 10 +----- 4 files changed, 50 insertions(+), 50 deletions(-) create mode 100644 doc/manual/main_frontend_reference.rst diff --git a/doc/manual/index.rst b/doc/manual/index.rst index 1d9091511..c9b0c8a96 100644 --- a/doc/manual/index.rst +++ b/doc/manual/index.rst @@ -18,6 +18,7 @@ ARTIQ documentation management_system drtio core_device + main_frontend_reference core_language_reference core_drivers_reference utilities diff --git a/doc/manual/main_frontend_reference.rst b/doc/manual/main_frontend_reference.rst new file mode 100644 index 000000000..bafcad453 --- /dev/null +++ b/doc/manual/main_frontend_reference.rst @@ -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 diff --git a/doc/manual/management_system.rst b/doc/manual/management_system.rst index 9e2ab603c..8cab4d847 100644 --- a/doc/manual/management_system.rst +++ b/doc/manual/management_system.rst @@ -195,44 +195,4 @@ 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. - :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 + :param values: Dictionary with names as keys and new argument values as values. \ No newline at end of file diff --git a/doc/manual/utilities.rst b/doc/manual/utilities.rst index 14dd2eb87..0da00dd54 100644 --- a/doc/manual/utilities.rst +++ b/doc/manual/utilities.rst @@ -3,15 +3,7 @@ Utilities .. Sort these tool by some subjective combination of their typical sequence and expected frequency of use. - - -Local running tool ------------------- - -.. argparse:: - :ref: artiq.frontend.artiq_run.get_argparser - :prog: artiq_run - + Static compiler ---------------