Examples

The following examples illustrate sphinxcontrib.argdoc output over a variety of ArgumentParser configurations. Links in the left-hand column show rendered output. Corresponding Python source code may be found in the right-hand column.

Rendered output	Python source code
Argument groups with short, long, or no descriptions	sphinxcontrib.argdoc.test.cases.c1_argument_group
Subcommands with no main program arguments	sphinxcontrib.argdoc.test.cases.c2_only_subparsers
Subcommands with main program arguments	sphinxcontrib.argdoc.test.cases.c3_main_plus_subparsers
Long-named subcommands, with main program arguments	sphinxcontrib.argdoc.test.cases.c4_with_long_subparsers
Subcommands, each having its own epilog	sphinxcontrib.argdoc.test.cases.c5_with_epilog
Multiple prefix characters	sphinxcontrib.argdoc.test.cases.c6_multiprefix
Use of 'noargdoc' function decorator	sphinxcontrib.argdoc.test.cases.c7_noargdoc
Exhaustively test all argument types	sphinxcontrib.argdoc.test.cases.c8_exhaustive
Subcommands of subcommands	sphinxcontrib.argdoc.test.cases.c9_subsubparsers