sphinxcontrib.argdoc.test.cases.c4_with_long_subparsers module

Long-named subcommands, with main program arguments

In this test case, we test a parser that has its own arguments as well as multiple subcommands, one of which has an exceedingly long name. This is mostly to test column alignment.

We also added a bunch of paragraphs and rich formatting to show how reStructuredText markup survives post-processing by sphinxcontrib.argdoc.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean feugiat tempor diam sed condimentum. Mauris aliquam interdum libero, ut aliquet erat malesuada sed. Mauris nec venenatis sapien, a feugiat neque. Sed pulvinar erat sit amet posuere aliquet. Phasellus non quam tincidunt, semper velit vitae, eleifend ante. Nam finibus vulputate diam. Fusce sit amet leo aliquam magna gravida fringilla et eu justo. Pellentesque vulputate elit id dignissim vehicula. Sed tempor interdum lacus, in dapibus magna interdum eu. Fusce lacinia turpis vel risus porta, eget dapibus nisi eleifend. Maecenas dictum nec nisi sit amet dignissim. Duis vestibulum ipsum a vestibulum placerat. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Nullam consequat nulla quis quam interdum, eu auctor ante molestie.

Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Ut egestas nec leo a luctus. Suspendisse libero magna, ultricies vel porttitor varius, vulputate nec orci. Ut et vehicula neque. Quisque ut libero eget sem pretium mollis elementum vitae quam. Etiam varius rutrum iaculis. Mauris consectetur cursus dolor nec tincidunt. Morbi aliquam elit ipsum, at aliquam purus ultricies sed. Donec tortor ante, consectetur et faucibus non, dignissim vitae eros. Duis pharetra convallis efficitur. Curabitur congue in tortor luctus molestie. Donec turpis felis, sollicitudin volutpat tristique quis, mattis at arcu. Praesent interdum luctus sodales. Sed imperdiet augue vulputate hendrerit tincidunt. Curabitur pharetra, odio in laoreet pretium, metus turpis posuere dui, quis aliquet leo nisl sollicitudin ligula.

Here is a table, to show that we can have rich formatting:

Column 1 Column 2
Some item Some other item.
Table row 2. Table row 2 column 2.
Another row. Row with a link to Python

See also

A definition list
The purpose of this See also section is just to show that we can use a number of reStructuredText structures, and still have the argument descriptions appended below.
Here is another item
To show that our test works

Command-line arguments

Positional arguments

Argument Description
mainarg1  
mainarg2 main positional argument #2, which we wrote helptext for (there was no help for mainarg1)

Optional arguments

Argument Description
-h, --help show this help message and exit

Subcommands

choose one of the following:

Argument Description
foo Run the foo subprogram
barbarbarbarbaraaeadslfjasdlkfjljalksjflsjdfladjfklasdjkfladsjglkjdasl Take output from foo subprogram and run it through the bar subprogram

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
fooarg1 foo argument 1
fooarg2 foo argument 2
Optional arguments
Argument Description
-h, --help show this help message and exit
-f  F short foo argument
--fookwarg  FOOKWARG foo keyword argument
-v  VERBOSE, --verbose  VERBOSE foo verbosely

barbarbarbarbaraaeadslfjasdlkfjljalksjflsjdfladjfklasdjkfladsjglkjdasl subcommand

This is the long description for the bar subprogram.

Positional arguments
Argument Description
bararg bar argument
Optional arguments
Argument Description
-h, --help show 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 bar subparser

Argument Description
--b1  B1  
--b2  B2 Argument 2 has help (bar argument 1 did not)
-k  N N Some other argument

Script contents

sphinxcontrib.argdoc.test.cases.c4_with_long_subparsers.main(argv=['-T', '-E', '-b', 'readthedocs', '-D', 'language=en', '.', '_build/html'])[source]