sphinxcontrib.argdoc.test.cases.c5_with_epilog module¶
Subcommands, each having its own epilog
An epilog should appear at the bottom of each command-group section
Command-line arguments¶
Positional arguments¶
Argument Description mainarg1mainarg2main positional argument #2, which has a description ( mainarg1did not)
Optional arguments¶
Argument Description -h,--helpshow this help message and exit
Subcommands¶
choose one of the following:
Argument Description fooRun the foosubprogrambarTake output from foosubprogram and run it through thebarsubprogram
This is a multi-line epilog which should appear at the bottom of the module docstring and also follow all of the options, arguments, et cetera.
foo subcommand¶
This is a long description of what a foo program might do. It spans
multiple lines, so that we can test things reasonably.
Positional arguments¶
Argument Description fooarg1foo argument 1 fooarg2foo argument 2
Optional arguments¶
Argument Description -h,--helpshow this help message and exit -f Fshort foo argument --fookwarg FOOKWARGfoo keyword argument -v VERBOSE,--verbose VERBOSEfoo verbosely
This is the epilog for the foo subprogram. It should appear at the end of
the foo subcommand section.
bar subcommand¶
This is the long description for the bar subcommand.
Positional arguments¶
Argument Description barargbar argument
Optional arguments¶
Argument Description -h,--helpshow this help message and exit --choice {option1,option2,option3}A keyword that requries a choice
An argument group¶
A special goup of arguments in the
barsubparser
Argument Description --b1 B1--b2 B2Argument 2 has help -k N NSome other argument
This the epilog for the bar subcommand. It is short.