sphinx-autogen¶
概述¶
sphinx-autogen [options] <sourcefile> …
描述¶
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), sphinx-apidoc(1)