• welcome to sphinxcontrib-argdoc
  • Introduction
  • Indices and tables
• Quickstart
  • Installation
  • Using sphinxcontrib.argdoc in your project
• Examples
• Advanced usage
  • Preventing sphinxcontrib-argdoc from processing one or more, but not all scripts, in a package
  • Processing a main-like function named something other than main
  • Using alternate prefix characters in your ArgumentParser
  • Debugging sphinxcontrib.argdoc output
• Frequently-asked questions
• Glossary of terms
• Related resources
  • Projects
  • Documentation guides
• Contributing
• License
  • The BSD 3-Clause License
• Technical documentation
  • Submodules
    • sphinxcontrib.argdoc.ext module
      • User functions
      • Developer functions
  • Subpackages
    • sphinxcontrib.argdoc.test package
      • 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