SPHINX-AUTOGEN(1) Sphinx SPHINX-AUTOGEN(1)
NAME
sphinx-autogen - Generate autodoc stub pages
SYNOPSIS
sphinx-autogen [options] <sourcefile> ...
DESCRIPTION
sphinx-autogen is a tool for automatic generation of Sphinx sources
that, using the autodoc extension, document items included in
autosummary listing(s).
sourcefile is the path to one or more reStructuredText documents con-
taining autosummary entries with the :toctree:: option set. sourcefile
can be an fnmatch-style pattern.
OPTIONS
-o <outputdir>
Directory to place the output file. If it does not exist, it is
created. Defaults to the value passed to the :toctree: option.
-s <suffix>, --suffix <suffix>
Default suffix to use for generated files. Defaults to rst.
-t <templates>, --templates <templates>
Custom template directory. Defaults to None.
-i, --imported-members
Document imported members.
-a, --respect-module-all
Document exactly the members in a module's __all__ attribute.
EXAMPLE
Given the following directory structure:
docs
├── index.rst
└── ...
foobar
├── foo
│ └── __init__.py
└── bar
├── __init__.py
└── baz
└── __init__.py
and assuming docs/index.rst contained the following:
Modules
=======
.. autosummary::
:toctree: modules
foobar.foo
foobar.bar
foobar.bar.baz
If you run the following:
$ PYTHONPATH=. sphinx-autogen docs/index.rst
then the following stub files will be created in docs:
docs
├── index.rst
└── modules
├── foobar.bar.rst
├── foobar.bar.baz.rst
└── foobar.foo.rst
and each of those files will contain a autodoc directive and some other
information.
SEE ALSO
sphinx-build(1), sphinx-apidoc(1)
COPYRIGHT
2007-2023, the Sphinx developers
5.3.0 Mar 29, 2023 SPHINX-AUTOGEN(1)
Generated by dwww version 1.15 on Sat Jun 29 02:40:19 CEST 2024.