sphinxcontrib.argdoc.test package

Test suites and test data for sphinxcontrib.argdoc

sphinxcontrib.argdoc.test.test_argdoc

Tests for the argdoc Sphinx extension sphinxcontrib.argdoc. All tests are implemented in here. The module docstring for sphinxcontrib.argdoc.test.test_argdoc contains information on how to add new test cases.

sphinxcontrib.argdoc.test.cases

executable scripts used as test cases for sphinxcontrib.argdoc

sphinxcontrib/argdoc/test/testdocroot

reStructuredText documentation stubs for executable scripts in the test suite, and a Sphinx configuration file (conf.py) that runs sphinxcontrib.argdoc

sphinxcontrib/argdoc/test/testbuild

Expected rst output from Sphinx from sphinxcontrib.argdoc

Submodules

• sphinxcontrib.argdoc.test.test_argdoc module
  • Test implementation
  • To add a test case for a new argparse configuration

Subpackages

• sphinxcontrib.argdoc.test.cases package
  • Submodules
    • sphinxcontrib.argdoc.test.cases.c1_argument_group module
      • Command-line arguments
        • Positional arguments
        • Optional arguments
        • One group of arguments
        • A second group of arguments
        • A final group of arguments, with no description
      • Script contents
    • sphinxcontrib.argdoc.test.cases.c2_only_subparsers module
      • Command-line arguments
        • Optional arguments
        • Subcommands
          • foo subcommand
            • Positional arguments
            • Optional arguments
          • bar subcommand
            • Positional arguments
            • Optional arguments
      • Script contents
    • sphinxcontrib.argdoc.test.cases.c3_main_plus_subparsers module
      • Command-line arguments
        • Positional arguments
        • Optional arguments
        • Subcommands
          • foo subcommand
            • Positional arguments
            • Optional arguments
          • bar subcommand
            • Positional arguments
            • Optional arguments
            • An argument group
      • Script contents
    • sphinxcontrib.argdoc.test.cases.c4_with_long_subparsers module
      • See also
      • Command-line arguments
        • Positional arguments
        • Optional arguments
        • Subcommands
          • foo subcommand
            • Positional arguments
            • Optional arguments
          • barbarbarbarbaraaeadslfjasdlkfjljalksjflsjdfladjfklasdjkfladsjglkjdasl subcommand
            • Positional arguments
            • Optional arguments
            • An argument group
      • Script contents
    • sphinxcontrib.argdoc.test.cases.c5_with_epilog module
      • Command-line arguments
        • Positional arguments
        • Optional arguments
        • Subcommands
          • foo subcommand
            • Positional arguments
            • Optional arguments
          • bar subcommand
            • Positional arguments
            • Optional arguments
            • An argument group
      • Script contents
    • sphinxcontrib.argdoc.test.cases.c6_multiprefix module
      • Command-line arguments
        • Positional arguments
        • Optional arguments
      • Script contents
    • sphinxcontrib.argdoc.test.cases.c7_nosphinxcontrib.argdoc module
      • See also
    • sphinxcontrib.argdoc.test.cases.c8_exhaustive module
      • See also
      • Command-line arguments
        • Positional arguments
        • Optional arguments
      • Script contents
    • sphinxcontrib.argdoc.test.cases.c9_subsubparsers
      • Command-line arguments
        • Positional arguments
        • Optional arguments
        • Subcommands
          • foo subcommand
            • Positional arguments
            • Optional arguments
            • Subcommands of the foo subcommand
              • foo-subfoo1 subcommand
                • Optional arguments
              • foo-subfoo2 subcommand
                • Optional arguments
              • foo-subfoo3 subcommand
                • Optional arguments
          • bar subcommand
            • Positional arguments
            • Optional arguments
            • An argument group
      • Script contents