Provided by: sphinx-common_1.6.7-1ubuntu1_all ![bug](/img/bug.png)
![bug](/img/bug.png)
NAME
sphinx-autogen - generate reStructuredText using autosummary directives
SYNOPSIS
sphinx-autogen [OPTIONS] sourcefile ...
OPTIONS
-o, --output-dir=output_dir the directory the output files should be written to -s, --suffix=suffix the suffix of the written files (defaults to rst) -t, --templates=directory custom template directory -i, --imported-members whether to document imported members (defaults to False)
DESCRIPTION
sphinx-autogen is a frontend to sphinx.ext.autosummary.generate. It generates the reStructuredText files from the autosummary directives contained in the given input files. The format of the autosummary directive is documented in the sphinx.ext.autosummary Python module and can be read using pydoc sphinx.ext.autosummary
SEE ALSO
sphinx-quickstart(1), sphinx-build(1) The Sphinx website ⟨http://sphinx-doc.org/⟩
AUTHOR
This man page was written by Jan Dittberner <jan@dittberner.info> for the Debian project (but may be used by others).