Linux cli command sphinx-autogen

➡ A Linux man page (short for manual page) is a form of software documentation found on Linux and Unix-like operating systems. This man-page explains the command sphinx-autogen and provides detailed information about the command sphinx-autogen, system calls, library functions, and other aspects of the system, including usage, options, and examples of _. You can access this man page by typing man followed by the sphinx-autogen.

  2 minute read  

NAME 🖥️ sphinx-autogen 🖥️

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 containing 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-2024, the Sphinx developers

░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░

  █║▌│║█║▌★ KALI ★ PARROT ★ DEBIAN 🔴 PENTESTING ★ HACKING ★ █║▌│║█║▌

              ██╗ ██╗ ██████╗  ██████╗ ██╗  ██╗███████╗██████╗
             ████████╗██╔══██╗██╔═══██╗╚██╗██╔╝██╔════╝██╔══██╗
             ╚██╔═██╔╝██║  ██║██║   ██║ ╚███╔╝ █████╗  ██║  ██║
             ████████╗██║  ██║██║   ██║ ██╔██╗ ██╔══╝  ██║  ██║
             ╚██╔═██╔╝██████╔╝╚██████╔╝██╔╝ ██╗███████╗██████╔╝
              ╚═╝ ╚═╝ ╚═════╝  ╚═════╝ ╚═╝  ╚═╝╚══════╝╚═════╝

               █║▌│║█║▌ WITH COMMANDLINE-KUNGFU POWER █║▌│║█║▌

░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░