sphinx-build 用法

sphinx-build 脚本构建了一个Sphinx文档集。用法如下:

$ sphinx-build [options] sourcedir builddir [filenames]

在这里，sourcedir 是指 源目录，builddir 是指你想指定的生成文档的目录。大部分时候，是不需要指定 filenames。

sphinx-build 脚本有如下的选项:

-b buildername

由 sphinx-quickstart 生成的 Makefile 和 make.bat 文件是只使用了 sphinx-build 的

给出生成的文档所在的路径。

-f, --force

通常，sphinx-apidoc不会重新生成任何文件。使用这个选项强制重新生成所有的文件。

-n, --dry-run

使用这个选项的话，不会有任何文件生成。（空运行，或者称为干运行。）

-s suffix

这个选项指定了输出的文件的文件名后缀。默认情况下，后缀是 rst。

-d maxdepth

如果存在内容表，设置内容表的最大深度。

-T, --no-toc

这可以防止生成的表的内容文件 modules.rst。但是当 --full 给出的时候，本选项就不起作用了。

-F, --full

此选项使得sphinx-apidoc创建一个完整的Sphinx项目，与 sphinx-quickstart 使用同样的机制。大部分的配置值是设置成默认的值，但是你可以通过如下选项修改一些重要的配置值。

-H project

设置项目名称，使得生成到输出的文件 (请见 project).

-A author

设置作者名，使得生成到输出的文件 (请见 copyright).

-V version

设置项目版本，使得生成到输出的文件 (请见 version).

-R release

设置项目发布，使得生成到输出的文件 (请见 release).