SPHINX-APIDOC(1)                    Sphinx                    SPHINX-APIDOC(1)

<?><?><?> (NAME)
       sphinx-apidoc - <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?> API <?><?><?><?> <?><?><?><?><?><?><?>

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       sphinx-apidoc [<?><?><?><?><?><?><?><?>] -o <OUTPUT_PATH> <MODULE_PATH>
       [EXCLUDE_PATTERN ...]

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?> sphinx-apidoc <?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?> (Sphinx) <?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> autodoc <#module-
       sphinx.ext.autodoc> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> API <?><?><?><?><?>
       <?><?><?><?><?><?>.

       <?><?><?><?><?> MODULE_PATH <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?> OUTPUT_PATH <?><?><?><?><?><?><?><?><?> <?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?>. <?><?><?><?><?><?> EXCLUDE_PATTERN
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?>/<?><?> <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?> fnmatch
       <https://docs.python.org/3/library/fnmatch.html> <?><?><?><?><?> <?><?>
       <?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?> <?><?>.

       <?><?><?><?><?>:
          <?><?><?><?><?> sphinx-apidoc <?><?><?><?><?><?><?><?>
          <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?>
          sphinx.ext.autodoc <#module-sphinx.ext.autodoc> <?><?><?><?>
          <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
          <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
          <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>. <?><?><?>
          <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?>
          (import) <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> (side
          effects) <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?>
          <?><?><?><?> <?><?><?><?><?> sphinx-build <?><?><?><?> autodoc
          <?><?><?><?> <?><?><?><?><?><?> <?><?>.

          <?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?><?><?><?>
          <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?> (<?><?>
          <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?>
          <?><?><?><?><?><?><?><?><?><?><?>)<?> <?><?><?><?><?><?><?>
          <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?>
          <?><?><?><?><?> <?><?><?><?> <?><?><?> if __name__ == '__main__'
          <?><?><?><?><?><?> <?><?><?> <?><?><?><?>.

<?><?><?><?><?><?><?><?> (OPTIONS)

       -o <OUTPUT_PATH>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>. <?><?><?>
              <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?>.

       -q     <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?> <?><?><?><?><?><?><?> <?> <?><?><?><?><?> <?><?>
              <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?>.

       -f, --force
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>.

       -l, --follow-links
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> (symbolic links)
              <?><?> <?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?><?><?>
              <?><?><?><?><?><?><?>: False.

       -n, --dry-run
              <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?>
              <?><?><?> <?><?><?><?><?><?><?>.

       -s <suffix>
              <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?><?><?>:
              rst.

       -d <MAXDEPTH>
              <?><?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?> (table of contents)
              <?><?><?><?><?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?><?><?>:
              4.

       --tocfile
              <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?><?><?>: modules.

       -T, --no-toc
              <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?>. <?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?> --full <?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?>.

       --remove-old
              <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?>
              <?><?><?><?><?><?>. <?><?> --full <?><?><?><?><?><?>
              <?><?><?><?>.

       -F, --full
              <?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
              (conf.py<?> Makefile <?> <?><?><?><?>) <?><?> <?><?>
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?> sphinx-quickstart <?><?><?><?><?>
              <?><?><?><?><?><?>.

       -e, --separate
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?>
              <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?>.

              <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> 1.2.

       -E, --no-headings
              <?><?><?><?> <?><?><?><?><?><?><?><?>/<?><?><?><?><?><?><?>
              <?><?><?><?><?> (heading) <?><?><?><?><?> <?><?><?><?><?><?><?>.
              <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?>
              docstring<?><?> <?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?> <?><?><?>.

       -P, --private
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> ("_private") <?><?>
              <?><?><?> <?><?><?><?> <?><?><?><?><?><?>.

              <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> 1.2.

       --implicit-namespaces
              <?><?><?><?> <?><?><?> <?><?><?><?><?><?> sphinx-apidoc
              <?><?><?><?><?><?><?> sys.path <https://docs.python.org/3/
              library/sys.html#sys.path> <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> __init__.py <?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.

              <?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?>
              <?><?><?><?><?><?> <?><?><?> <?><?><?><?> (implicit namespaces)
              <?><?><?><?><?> <?><?> PEP 420 <https://peps.python.org/
              pep-0420> <?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
              foo/bar/module.py <?><?> foo/bar/baz/__init__.py <?><?>
              <?><?><?><?> <?><?><?><?><?><?><?> (<?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?> <?><?> foo <?> bar <?><?><?><?> <?><?><?>
              <?><?><?><?><?><?> <?><?> <?><?><?><?><?>).

       -M, --module-first
              <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?> <?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?>.

       <?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> --full
       <?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?>:

       -a     <?><?><?><?> module_path <?><?> <?><?> sys.path <?><?><?><?><?>
              <?><?><?><?><?><?>.

       -H <project>
              <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?> <?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?> (<?><?><?><?><?><?>: project
              <#confval-project>).

       -A <author>
              <?><?><?> <?><?><?><?><?><?><?>(<?><?>) <?><?> <?><?><?><?>
              <?><?><?> <?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
              (<?><?><?><?><?><?>: copyright <#confval-copyright>).

       -V <version>
              <?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?>
              <?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?> (<?><?><?><?><?><?>: version
              <#confval-version>).

       -R <release>
              <?><?><?><?><?> <?><?><?><?><?><?> (release) <?><?><?><?><?>
              <?><?> <?><?><?><?> <?><?><?> <?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
              (<?><?><?><?><?><?>: release <#confval-release>).

       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> (Project templating)

       <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> 2.2:
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> sphinx-apidoc

       -t, --templatedir=TEMPLATEDIR
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?>. <?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
              apidoc <?><?> <?><?><?><?><?> <?><?><?><?>.
              <?><?><?><?><?><?><?><?> <?><?><?><?> Jinja2 <?><?><?>
              <?><?><?><?> <?><?><?><?><?>:

              o module.rst.jinja

              o package.rst.jinja

              o toc.rst.jinja

              o root_doc.rst.jinja

              o conf.py.jinja

              o Makefile.jinja

              o Makefile.new.jinja

              o make.bat.jinja

              o make.bat.new.jinja

              <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?>
              Sphinx <?><?><?><?><?><?> <?><?><?><?>.
              (sphinx/templates/apidoc <?> sphinx/templates/quickstart)

<?><?><?><?> (ENVIRONMENT)

       SPHINX_APIDOC_OPTIONS
              <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?>
              <?><?> <?><?><?><?><?><?><?><?><?><?><?><?><?><?> automodule
              <?><?><?><?><?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?><?><?>:
              members,undoc-members,show-inheritance.

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       sphinx-build(1), sphinx-autogen(1)

<?><?> <?><?><?> (COPYRIGHT)
       2007-2026, the Sphinx developers

9.1.0                            March 4, 2026                SPHINX-APIDOC(1)