sphinxcontrib.argdoc
  • 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
    • Workflow
    • Formatting
  • License
    • The BSD 3-Clause License
  • Technical documentation
    • Submodules
      • sphinxcontrib.argdoc.ext module
        • User functions
        • Developer functions
    • Subpackages
      • sphinxcontrib.argdoc.test package
        • Submodules
        • Subpackages
 
sphinxcontrib.argdoc
  • Docs »
  • Examples
  • Edit on Bitbucket

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
Next Previous

© Copyright 2015, Joshua G. Dunn.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.