OS Manuals

/usr/bin/sphinx-autogen

Executable binaries for sphinx-7 installed for python3.11

From py3.11-sphinx-7-bin 7.4.7-r7 (os), captured 2026-11-05 by running sphinx-autogen --help (exit 0). permalink

usage: sphinx-autogen [OPTIONS] <SOURCE_FILE>...

Generate ReStructuredText using autosummary directives. sphinx-autogen is a frontend to
sphinx.ext.autosummary.generate. It generates the reStructuredText files from the autosummary
directives contained in the given input files. The format of the autosummary directive is
documented in the ``sphinx.ext.autosummary`` Python module and can be read using:: pydoc
sphinx.ext.autosummary

positional arguments:
  source_file           source files to generate rST files for

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                        directory to place all output in
  -s SUFFIX, --suffix SUFFIX
                        default suffix for files (default: rst)
  -t TEMPLATES, --templates TEMPLATES
                        custom template directory (default: None)
  -i, --imported-members
                        document imported members (default: False)
  -a, --respect-module-all
                        document exactly the members in module __all__ attribute. (default: False)
  --remove-old          Remove existing files in the output directory that were not generated

For more information, visit <https://www.sphinx-doc.org/>.
Options (5)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--versionshow program's version number and exithelp
-i, --imported-membersdocument imported members (default: False)help
-a, --respect-module-alldocument exactly the members in module __all__ attribute.help
--remove-oldRemove existing files in the output directory that were not generatedhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.