sphinx-quickstart¶
概要¶
sphinx-quickstart
说明¶
sphinx-quickstart 是一个交互式命令行工具,它会问你一些问题,根据你对项目的描述,创建一个完整的文档目录结构,以及一个例子 Makefile 可以配合 sphinx-build(1) 使用。
选项¶
- -h, --help, --version¶
显示使用方法简介,或者 Sphinx 版本号。
目录结构选项
- --sep¶
如果设置此选项,将使用单独的源目录与生成目录。
- --no-sep¶
If specified, create build directory under source directory.
- --dot=DOT¶
这个选项在根目录中创建两个文件夹:“_templates”用于自定义 HTML 模板文件,“_static”用于自定义样式表及其他静态文件。你可以指定不同的前缀(比如“.”)代替下划线。
项目基本选项
扩展选项
- --ext-autodoc¶
Enable
sphinx.ext.autodoc
extension.
- --ext-doctest¶
启用 sphinx.ext.doctest 扩展程序。
- --ext-intersphinx¶
启用 sphinx.ext.intersphinx 扩展程序。
- --ext-todo¶
启用 sphinx.ext.todo 扩展程序。
- --ext-coverage¶
启用 sphinx.ext.coverage 扩展程序。
- --ext-imgmath¶
启用 sphinx.ext.imgmath 扩展程序。
- --ext-mathjax¶
启用 sphinx.ext.mathjax 扩展程序。
- --ext-ifconfig¶
启用 sphinx.ext.ifconfig 扩展程序。
- --ext-viewcode¶
启用 sphinx.ext.viewcode 扩展程序。
- --ext-githubpages¶
启用 sphinx.ext.githubpages 扩展。
- --extensions=EXTENSIONS¶
启用任意扩展。
Makefile 和 Batchfile 的创建选项
- --use-make-mode (-m), --no-use-make-mode (-M)¶
Makefile/make.bat
使用(或不使用):ref:make-mode<make_mode>。默认值是使用
,这会生成一个更加简明的Makefile/make.bat
文件。在 1.5 版本发生变更: 默认为使用 make-mode。
在 7.3 版本发生变更: Support for disabling the make-mode will be removed in Sphinx 8.
- --makefile, --no-makefile¶
创建(或不创建)makefile。
- --batchfile, --no-batchfile¶
创建(或不创建)批处理文件
项目模板
Added in version 1.5: 用于 sphinx-quickstart 程序的项目模板选项
- -t, --templatedir=TEMPLATEDIR¶
指定项目模板文件所在的文件夹。你可以修改 quickstart 生成的 Sphinx 项目文件中的模板。以下 Jinja2 模板可供使用:
root_doc.rst_t
conf.py_t
Makefile_t
Makefile.new_t
make.bat_t
make.bat.new_t
详细内容参见 Sphinx 系统提供的模板文件。(
sphinx/templates/quickstart
)
- -d NAME=VALUE¶
定义模板变量
另请参阅¶
sphinx-build(1)