/usr/bin/sphinx-apidoc

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.

positional arguments:
  module_path           path to module to document
  exclude_pattern       fnmatch-style file and/or directory patterns to exclude from generation

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -o DEST_DIR, --output-dir DEST_DIR
                        directory to place all output
  -q                    no output on stdout, just warnings on stderr
  -d MAX_DEPTH, --maxdepth MAX_DEPTH
                        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
  --tocfile TOC_FILE    filename of table of contents (default: 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
  --automodule-options AUTOMODULE_OPTIONS
                        Comma-separated list of options to pass to automodule directive (or use
                        SPHINX_APIDOC_OPTIONS).
  -s SUFFIX, --suffix SUFFIX
                        file suffix (default: rst)
  --remove-old          Remove existing files in the output directory that were not generated
  -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

extension options:
  --extensions EXTENSIONS
                        enable arbitrary extensions, used when --full is given
  --ext-autodoc         enable autodoc extension, used when --full is given
  --ext-doctest         enable doctest extension, used when --full is given
  --ext-intersphinx     enable intersphinx extension, used when --full is given
  --ext-todo            enable todo extension, used when --full is given
  --ext-coverage        enable coverage extension, used when --full is given
  --ext-imgmath         enable imgmath extension, used when --full is given
  --ext-mathjax         enable mathjax extension, used when --full is given
  --ext-ifconfig        enable ifconfig extension, used when --full is given
  --ext-viewcode        enable viewcode extension, used when --full is given
  --ext-githubpages     enable githubpages extension, used when --full is given

Project templating:
  -t TEMPLATEDIR, --templatedir TEMPLATEDIR
                        template directory for template files

For more information, visit <https://www.sphinx-doc.org/>.