Browse Source

docs: cli (wip)

whitelist
Sebastian Heimann 3 years ago
parent
commit
cf814eecc8
  1. 0
      docs/source/cli/check.rst
  2. 0
      docs/source/cli/diff.rst
  3. 0
      docs/source/cli/events.rst
  4. 0
      docs/source/cli/export.rst
  5. 0
      docs/source/cli/forward.rst
  6. 0
      docs/source/cli/go.rst
  7. 0
      docs/source/cli/harvest.rst
  8. 33
      docs/source/cli/index.rst
  9. 0
      docs/source/cli/init.rst
  10. 0
      docs/source/cli/movie.rst
  11. 0
      docs/source/cli/plot.rst
  12. 0
      docs/source/cli/qc-polarization.rst
  13. 0
      docs/source/cli/report.rst
  14. 0
      docs/source/cli/scenario.rst
  15. 0
      docs/source/cli/upgrade-config.rst
  16. 0
      docs/source/cli/version.rst
  17. 23
      docs/source/commands/index.rst

0
docs/source/commands/check.rst → docs/source/cli/check.rst

0
docs/source/commands/diff.rst → docs/source/cli/diff.rst

0
docs/source/commands/events.rst → docs/source/cli/events.rst

0
docs/source/commands/export.rst → docs/source/cli/export.rst

0
docs/source/commands/forward.rst → docs/source/cli/forward.rst

0
docs/source/commands/go.rst → docs/source/cli/go.rst

0
docs/source/commands/harvest.rst → docs/source/cli/harvest.rst

33
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

0
docs/source/commands/init.rst → docs/source/cli/init.rst

0
docs/source/commands/movie.rst → docs/source/cli/movie.rst

0
docs/source/commands/plot.rst → docs/source/cli/plot.rst

0
docs/source/commands/qc-polarization.rst → docs/source/cli/qc-polarization.rst

0
docs/source/commands/report.rst → docs/source/cli/report.rst

0
docs/source/commands/scenario.rst → docs/source/cli/scenario.rst

0
docs/source/commands/upgrade-config.rst → docs/source/cli/upgrade-config.rst

0
docs/source/commands/version.rst → docs/source/cli/version.rst

23
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
Loading…
Cancel
Save