MichaelWedel
commented
7 years ago There's also https://pythonhosted.org/sphinxcontrib-autoprogram/ which in my opinion leads to a nicer formatting that is more consistent with what we have so far. The drawback is that the current version (0.1.3) only works with Python 3 and version 0.1.2 does not format the "usage" message properly. Release 0.1.4 which would fix both problems is not out yet.
Currently we do not have auto-generated documentation for command line script usage. There is a Sphinx extension (http://sphinx-argparse.readthedocs.io/en/latest/index.html) that extracts that from the argparser of a script.
This should be added to the user guide, while the documentation should also be updated a bit to be a bit nicer and more descriptive where it isn't.