Sphinx (sphinx-apidoc) 1.5.6

Usage: sphinx-apidoc [options] -o <output_path> <module_path> [exclude_pattern, ...] Look recursively in <module_path> for Python modules and packages and create one reST file with automodule directives per package in the <output_path>. The <exclude_pattern>s can be file and/or directory patterns that will be excluded from generation. Note: By default this script will not overwrite already created files. Options: -h, --help show this help message and exit -o DESTDIR, --output-dir=DESTDIR Directory to place all output -d MAXDEPTH, --maxdepth=MAXDEPTH Maximum depth of submodules to show in the TOC (default: 4) -f, --force Overwrite existing files -l, --follow-links Follow symbolic links. Powerful when combined with collective.recipe.omelette. -n, --dry-run Run the script without creating files -e, --separate Put documentation for each module on its own page -P, --private Include "_private" modules -T, --no-toc Don't create a table of contents file -E, --no-headings Don't create headings for the module/package packages (e.g. when the docstrings already contain them) -M, --module-first Put module documentation before submodule documentation --implicit-namespaces Interpret module paths according to PEP-0420 implicit namespaces specification -s SUFFIX, --suffix=SUFFIX file suffix (default: rst) -F, --full Generate a full project with sphinx-quickstart -a, --append-syspath Append module_path to sys.path, used when --full is given -H HEADER, --doc-project=HEADER Project name (default: root module name) -A AUTHOR, --doc-author=AUTHOR Project author(s), used when --full is given -V VERSION, --doc-version=VERSION Project version, used when --full is given -R RELEASE, --doc-release=RELEASE Project release, used when --full is given, defaults to --doc-version --version Show version information and exit