Scroll to navigation

AUTODOC2(1) User Commands AUTODOC2(1)

NAME

autodoc2 - Sphinx extension to automatically generate API doc for Py packages

DESCRIPTION

Usage: autodoc2 [OPTIONS] COMMAND [ARGS]...
CLI for sphinx-autodoc2

Options --version -v Show the application version and exit. --install-completion Install completion for the current shell. --show-completion Show completion for the current shell, to copy it or customize the installation. --help -h Show this message and exit. Commands create-db Create a database for a python module or package. list Analyse a python module or package and stream the results to the console. resolve-all Analyse the __all__ of a module and find potential matches write Create sphinx files for a python module or package.

SEE ALSO

The full documentation for autodoc2 is maintained as a Texinfo manual. If the info and autodoc2 programs are properly installed at your site, the command

info autodoc2

should give you access to the complete manual.

August 2024 autodoc2 version: 0.5.0