Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
225 lines (125 sloc) 5.87 KB

调用 sphinx-build

脚本 :program:`sphinx-build` 用来建立Sphinx文档集. 调用方式:

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

sourcedir 是源文件目录 :term:`source directory` , builddir 是生成文件目录.一般不需要写 filenames .

脚本 :program:`sphinx-build` 的选项:

源目录与目标目录后面,可以给出一个到多个文件名. Sphinx会尝试仅生成这些文件(及其依赖文件).

Makefile 选项

文件 :file:`Makefile`:file:`make.bat`:program:`sphinx-quickstart` 创建,脚本 :program:`sphinx-build` 仅使用选项 :option:`-b`:option:`-d` .它们则支持以下自定义行为的变量:

调用 sphinx-apidoc

程序 :program:`sphinx-apidoc` 将Python页面自动生成API文档.调用方式:

$ sphinx-apidoc [options] -o outputdir packagedir [pathnames]

这里 packagedir 是生成文档的页面的根目录, outputdir 则是生成源文件的输出目录. pathnames 给出的路径在生成时不会被忽略.

脚本 :program:`sphinx-apidoc` 也有一些选项:

Something went wrong with that request. Please try again.