Skip to content

Commit

Permalink
Added CLI documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Paebbels committed Jun 24, 2024
1 parent da262ec commit 6013250
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
17 changes: 17 additions & 0 deletions doc/CommandLineInterface.rst
Original file line number Diff line number Diff line change
@@ -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 <cmd> -h`` or ``pyedaa-reports help <cmd>``. 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:
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ Contributors
:caption: References and Reports
:hidden:

CommandLineInterface
pyEDAA.Reports/pyEDAA.Reports
reports/unittests
reports/coverage/index
Expand Down

0 comments on commit 6013250

Please sign in to comment.