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 »
  • Related resources
  • Edit on Bitbucket

Related resources¶

Projects¶

If you’re interested in sphinxcontrib.argdoc, a number of other projects & resources might interest you, too:

sphinx-argparse
Another automated documentation generator for executable scripts that use argparse. sphinx-argparse is highly configurable and offers more flexibility than argdoc, but requires a little more setup.
sphinx.ext.autodoc
Bundled Sphinx extension that produces documentation from module, class, and function docstrings.
numpydoc
A docstring post-processor and formatting standard that converts very human-readable docstrings into very nice output in Sphinx.

Documentation guides¶

reStructuredText specification
Details of how to format text for rich output under Sphinx or other formatting engines.
PEP257
Style guide for Python docstrings (extended by numpy documentation guide).
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.