Sphinx--Autogen

提纲

sphinx-autogen [options] <sourcefile> ...

描述

sphinx-autogen 是一个用于自动生成Sphinx源代码的工具，它使用 autodoc 扩展名，文档项目包含在 autosummary 上市(S)。

sourcefile 是一个或多个包含以下内容的reStructuredText文档的路径 autosummary 条目与所述 :toctree: 选项集。 sourcefile 可以是 fnmatch - 风格图案。

选项

-o <outputdir>

放置输出文件的目录。如果它不存在，则创建它。默认设置为传递给 :toctree: 选择。

-s <suffix>, --suffix <suffix>

用于生成的文件的默认后缀。默认为 rst 。

-t <templates>, --templates <templates>

自定义模板目录。默认为 None 。

-i, --imported-members

记录导入的成员。

-a, --respect-module-all

准确记录模块的 __all__ 属性。

--remove-old

删除输出目录中不再生成的现有文件。

示例

给定以下目录结构：

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

然后，将在中创建以下存根文件 docs **

docs
├── index.rst
└── modules
    ├── foobar.bar.rst
    ├── foobar.bar.baz.rst
    └── foobar.foo.rst

并且每个文件都将包含一个 autodoc 指令和其他一些信息。

另请参阅

sphinx-build(1), sphinx-apidoc(1)