sphinx-autogen

梗概

sphinx-autogen [选项] <源文件> …

描述

sphinx-autogen 是一个用于自动生成 Sphinx 源文件的工具,它使用 autodoc 扩展,文档化包含在 autosummary 列表中的项目.

sourcefile 是一个或多个包含 autosummary 条目的 reStructuredText 文档的路径,这些条目设置了 :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),:manpage:sphinx-apidoc(1)