SPHINX-AUTOGEN(1)                   Sphinx                   SPHINX-AUTOGEN(1)

<?><?><?> (NAME)
       sphinx-autogen - <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
       (stub) <?><?><?><?> autodoc

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       sphinx-autogen [options] <sourcefile> ...

<?><?><?><?><?><?><?> (DESCRIPTION)
       sphinx-autogen <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?><?> Sphinx <?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> autodoc <#module-
       sphinx.ext.autodoc><?> <?><?><?><?><?><?> <?><?> <?><?> <?><?>
       <?><?><?><?><?>(<?><?><?>) autosummary <#directive-autosummary>
       <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?>.

       sourcefile <?><?><?><?> <?><?> <?><?> <?><?><?> <?><?><?>
       reStructuredText <?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
       autosummary <#directive-autosummary> <?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?> :toctree:
       <?><?><?><?><?>. sourcefile <?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?> <?><?><?> fnmatch <https://docs.python.org/3/library/fnmatch
       .html#module-fnmatch> <?><?><?><?>.

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

       -o <outputdir>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?> <?><?><?><?> <?><?><?><?><?>. <?><?><?>
              <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?>
              <?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?> <?><?>
              <?><?> <?><?><?><?><?><?><?> :toctree: <?><?><?><?> <?><?><?>
              <?><?><?>.

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

       -t <templates>, --templates <templates>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?>. <?><?><?><?><?> <?><?><?><?><?><?><?> None
              <?><?><?>.

       -i, --imported-members
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?> (imported members).

       -a, --respect-module-all
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?> __all__
              <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?>.

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

<?><?><?><?><?><?><?> (EXAMPLES)
       <?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
       <?><?><?>:

          docs
          <?><?><?> index.rst
          <?><?><?> ...
          foobar
          <?><?><?> foo
          |   <?><?><?> __init__.py
          <?><?><?> bar
              <?><?><?> __init__.py
              <?><?><?> baz
                  <?><?><?> __init__.py

       <?> <?><?> <?><?><?> <?><?><?><?><?> docs/index.rst <?><?><?><?>
       <?><?><?><?><?> <?><?><?> <?><?><?><?>:

          Modules
          =======

          .. autosummary::
             :toctree: modules

             foobar.foo
             foobar.bar
             foobar.bar.baz

       <?><?><?> <?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?> <?><?><?><?>:

          $ PYTHONPATH=. sphinx-autogen docs/index.rst

       <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> (stub)
       <?><?><?> <?><?> docs <?><?><?><?><?> <?><?><?><?><?><?> <?><?>:

          docs
          <?><?><?> index.rst
          <?><?><?> modules
              <?><?><?> foobar.bar.rst
              <?><?><?> foobar.bar.baz.rst
              <?><?><?> foobar.foo.rst

       <?> <?><?> <?><?> <?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?> <?><?><?><?><?><?><?><?><?><?> autodoc <#module-sphinx.ext
       .autodoc> <?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?> <?><?><?>.

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

<?><?><?><?><?><?><?><?> <?> <?><?><?><?><?> (COPYRIGHT)
       2007-2026<?> <?><?><?><?><?><?><?><?><?><?><?><?><?> Sphinx

9.1.0                            March 4, 2026               SPHINX-AUTOGEN(1)