summaryrefslogtreecommitdiff
path: root/README
blob: ac0ccfa8ec9f903694b3fb472b83aab9857a5a8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
usage: argparse-html.py [-h] [-a ARG_A] [-b PARAM_B] [-v] [-d] [-c]
                        [--html-usage] [--html-usage-raw]

    This script demonstrates how to automatically convert argparse
    output to HTML. See also the class HTMLFormatter.

    It's a hack. It does not produce a very clean HTML (there's an
    extra '</ul>, for instance). But it's good enough for me. An empty
    (or spaces-only) line is considered as a paragraph separator.

    I needed to produce HTML as a single line and thus this is the
    default output. This is not part of the class and can be easily
    changed in the wrapper function html_usage().

    

optional arguments:
  -h, --help            show this help message and exit
  -a ARG_A, --arg-a ARG_A
                        Set value of A. Default: 1.1.
  -b PARAM_B, --param-b PARAM_B
                        Set value of B. Default: 2.
  -v, --verbose         Be verbose

For Interactive Use:
  -d, --no-act          Do nothing. Just print what is to be run
  -c, --config          Do nothing. Just show configuration
  --html-usage          Do nothing. Format help as HTML (a single line)
  --html-usage-raw      If html-usage: don't squash HTML to a single line

    Note that we use RawTextHelpFormatter as the parser, rather than
    HelpFormatter itself. Otherwise splitting to paragarphs with empty
    lines won't show up in the standard --help output.

    If you have no problem with that, you can remove the formatter_class
    parameter above.