From 60132503366e1987c89f791b7956c9cf861fbdb2 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Mon, 24 Jun 2024 07:36:25 +0200 Subject: [PATCH] Added CLI documentation. --- doc/CommandLineInterface.rst | 17 +++++++++++++++++ doc/index.rst | 1 + 2 files changed, 18 insertions(+) create mode 100644 doc/CommandLineInterface.rst diff --git a/doc/CommandLineInterface.rst b/doc/CommandLineInterface.rst new file mode 100644 index 00000000..6b5a243b --- /dev/null +++ b/doc/CommandLineInterface.rst @@ -0,0 +1,17 @@ +Command Line Interfaces +####################### + +When installed via PIP, the command line program ``pyedaa-reports`` is registered in the Python installation's +``Scripts`` directory. Usually this path is listed in ``PATH``, thus this program is globally available after +installation. + +The program is self-describing. Use ``pyedaa-reports`` without parameters or ``pyedaa-reports help`` to see all +available common options and commands. Each command has then it's own help page for command specific options, which can +be listed by calling ``pyedaa-reports -h`` or ``pyedaa-reports help ``. The ``pyedaa-reports``'s version and +license information is shown by calling ``pyedaa-reports version``. + +.. _References:cli: + +.. autoprogram:: pyEDAA.Reports.CLI:Application().MainParser + :prog: pyedaa-reports + :groups: diff --git a/doc/index.rst b/doc/index.rst index 3929c9ce..cd4f0876 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -115,6 +115,7 @@ Contributors :caption: References and Reports :hidden: + CommandLineInterface pyEDAA.Reports/pyEDAA.Reports reports/unittests reports/coverage/index