From 179aecaf41612f4236792a4885fae138e5ea0aea Mon Sep 17 00:00:00 2001
From: Martin Blanchard <martin.blanchard@codethink.co.uk>
Date: Wed, 19 Sep 2018 14:24:58 +0100
Subject: [PATCH] docs: Update and fix CLI reference documentation
---
docs/source/reference_cli.rst | 56 +++++++++++++++++++----------------
1 file changed, 31 insertions(+), 25 deletions(-)
diff --git a/docs/source/reference_cli.rst b/docs/source/reference_cli.rst
index 57c28a2b6..62333d0bb 100644
--- a/docs/source/reference_cli.rst
+++ b/docs/source/reference_cli.rst
@@ -1,5 +1,5 @@
-.. _cli_reference:
+.. _cli-reference:
CLI reference
=============
@@ -8,112 +8,118 @@ BuildGrid's Command Line Interface (CLI) reference documentation.
----
-.. _invoking_bgd:
+.. _invoking-bgd:
.. click:: buildgrid._app:cli
:prog: bgd
----
-.. _invoking_bgd_bot:
+.. _invoking-bgd-bot:
.. click:: buildgrid._app.commands.cmd_bot:cli
:prog: bgd bot
----
-.. _invoking_bgd_bot_buildbox:
+.. _invoking-bgd-bot-buildbox:
.. click:: buildgrid._app.commands.cmd_bot:run_buildbox
:prog: bgd bot buildbot
----
-.. _invoking_bgd_bot_dummy:
+.. _invoking-bgd-bot-dummy:
.. click:: buildgrid._app.commands.cmd_bot:run_dummy
:prog: bgd bot dummy
----
-.. _invoking_bgd_bot_temp_directory:
+.. _invoking-bgd-bot-temp-directory:
.. click:: buildgrid._app.commands.cmd_bot:run_temp_directory
:prog: bgd bot temp-directory
----
-.. _invoking_bgd_cas:
+.. _invoking-bgd-cas:
.. click:: buildgrid._app.commands.cmd_cas:cli
:prog: bgd cas
----
-.. _invoking_bgd_cas_upload_dir:
+.. _invoking-bgd-cas-upload-dir:
.. click:: buildgrid._app.commands.cmd_cas:upload_dir
:prog: bgd cas upload-dir
----
-.. _invoking_bgd_cas_upload_files:
+.. _invoking-bgd-cas-upload-files:
.. click:: buildgrid._app.commands.cmd_cas:upload_files
:prog: bgd cas upload-files
----
-.. _invoking_bgd_execute:
+.. _invoking-bgd-execute:
.. click:: buildgrid._app.commands.cmd_execute:cli
:prog: bgd execute
----
-.. _invoking_bgd_execute_command:
+.. _invoking-bgd-execute-command:
.. click:: buildgrid._app.commands.cmd_execute:command
:prog: bgd execute command
----
-.. _invoking_bgd_execute_list:
+.. _invoking-bgd-execute-request-dummy:
-.. click:: buildgrid._app.commands.cmd_execute:list_operations
- :prog: bgd execute list
+.. click:: buildgrid._app.commands.cmd_execute:request_dummy
+ :prog: bgd execute request-dummy
----
-.. _invoking_bgd_execute_ request_dummy:
+.. _invoking-bgd-operation:
-.. click:: buildgrid._app.commands.cmd_execute:request_dummy
- :prog: bgd execute request-dummy
+.. click:: buildgrid._app.commands.cmd_operation:cli
+ :prog: bgd operation
----
-.. _invoking_bgd_execute_status:
+.. _invoking-bgd-operation-list:
-.. click:: buildgrid._app.commands.cmd_execute:operation_status
- :prog: bgd execute status
+.. click:: buildgrid._app.commands.cmd_operation:lists
+ :prog: bgd operation list
----
-.. _invoking_bgd_execute_wait:
+.. _invoking-bgd-operation-status:
-.. click:: buildgrid._app.commands.cmd_execute:wait_execution
- :prog: bgd execute wait
+.. click:: buildgrid._app.commands.cmd_operation:status
+ :prog: bgd operation status
----
-.. _invoking_bgd_server:
+.. _invoking-bgd-operation-wait:
+
+.. click:: buildgrid._app.commands.cmd_operation:wait
+ :prog: bgd operation wait
+
+----
+.. _invoking-bgd-server:
.. click:: buildgrid._app.commands.cmd_server:cli
:prog: bgd server
----
-.. _invoking_bgd_server_start:
+.. _invoking-bgd-server-start:
.. click:: buildgrid._app.commands.cmd_server:start
:prog: bgd server start
--
GitLab