docs: cli (wip)

3 years ago · cf814eecc8
17 changed files with 33 additions and 23 deletions
--- a/docs/source/commands/check.rst
+++ b/docs/source/commands/check.rst
--- a/docs/source/commands/diff.rst
+++ b/docs/source/commands/diff.rst
--- a/docs/source/commands/events.rst
+++ b/docs/source/commands/events.rst
--- a/docs/source/commands/export.rst
+++ b/docs/source/commands/export.rst
--- a/docs/source/commands/forward.rst
+++ b/docs/source/commands/forward.rst
--- a/docs/source/commands/go.rst
+++ b/docs/source/commands/go.rst
--- a/docs/source/commands/harvest.rst
+++ b/docs/source/commands/harvest.rst
--- a/docs/source/cli/index.rst
+++ b/docs/source/cli/index.rst
@ -0,0 +1,33 @@
+Command line interface
+======================
+
+Grond is a normally invoked as a command line program by calling ``grond`` from
+the Unix/Linux shell. It's command line interface (CLI) uses the standard
+Unix/Linux conventions for its options and arguments.  To get a brief summary
+on any of its subcommands, add the ``--help`` option. Options are recognized by
+their leading double-dashes, e.g. ``--help``. Some options in Grond have short aliases
+with single dashes.
+
+.. command-output:: grond --help
+
+Grond subcommands
+-----------------
+
+.. toctree::
+    :caption: Subcommands:
+
+    scenario
+    init
+    events
+    check
+    go
+    forward
+    harvest
+    plot
+    movie
+    export
+    report
+    diff
+    qc-polarization
+    upgrade-config
+    version
--- a/docs/source/commands/init.rst
+++ b/docs/source/commands/init.rst
--- a/docs/source/commands/movie.rst
+++ b/docs/source/commands/movie.rst
--- a/docs/source/commands/plot.rst
+++ b/docs/source/commands/plot.rst
--- a/docs/source/commands/qc-polarization.rst
+++ b/docs/source/commands/qc-polarization.rst
--- a/docs/source/commands/report.rst
+++ b/docs/source/commands/report.rst
--- a/docs/source/commands/scenario.rst
+++ b/docs/source/commands/scenario.rst
--- a/docs/source/commands/upgrade-config.rst
+++ b/docs/source/commands/upgrade-config.rst
--- a/docs/source/commands/version.rst
+++ b/docs/source/commands/version.rst
--- a/docs/source/commands/index.rst
+++ b/docs/source/commands/index.rst
@ -1,23 +0,0 @@
-Command reference
-=================
-
-.. command-output:: grond --help
-
-.. toctree::
-    :caption: Subcommands:
-
-    scenario
-    init
-    events
-    check
-    go
-    forward
-    harvest
-    plot
-    movie
-    export
-    report
-    diff
-    qc-polarization
-    upgrade-config
-    version