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 thanargdoc, 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).