sphinx-apidoc is a command-line tool for automatic generation of Sphinx reStructuredText sources, that, with the Sphinx autodoc extension, document a whole package in the style of other automatic API documentation tools.
sphinx-apidoc is a tool for automatic generation of Sphinx sources that document a whole package.
Usage of the sphinx-apidoc command is as follows:
sphinx-apidoc [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN …]
Sphinx-apidoc uses autodoc to extract docstrings from source files (located in <MODULE_PATH>) and places the resulting .rst reStructuredText files in OUTPUT_PATH. Latter, documentation can be generated from those .rst files into several formats like HTML, PDF using sphinx-build.
The documentation of sphinx-apidoc can be found here.
See also: autodoc
Links
