sphinx-quickstart¶
概要¶
sphinx-quickstart
描述¶
sphinx-quickstart 是一个交互式工具,它会询问一些有关您的项目的问题,然后生成一个完整的文档目录和样本 Makefile,供 sphinx-build(1) 使用。
选项¶
- -q, --quiet¶
静默模式,跳过用于指定选项的交互式向导。此选项需要 -p、-a 和 -v 选项。
- -h, --help, --version¶
显示使用摘要或 Sphinx 版本。
结构选项
- --sep¶
如果指定,则分离源目录和构建目录。
- --no-sep¶
如果指定,则在源目录下创建构建目录。
- --dot=DOT¶
在根目录内,将创建两个更多目录;“_templates”用于自定义 HTML 模板,以及“_static”用于自定义样式表和其他静态文件。您可以输入另一个前缀(例如“.”)来替换下划线。
项目基本选项
- --suffix=SUFFIX¶
源文件后缀。(参见
source_suffix
)。
扩展选项
- --ext-autodoc¶
启用
sphinx.ext.autodoc
扩展。
- --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 和批处理文件创建选项
- --use-make-mode (-m), --no-use-make-mode (-M)¶
Makefile/make.bat
使用(或不使用)make 模式。默认值为use
,它会生成一个更简洁的Makefile/make.bat
。在版本 1.5 中更改: make 模式为默认值。
在版本 7.3 中更改: 在 Sphinx 8 中将删除禁用 make 模式的支持。
在版本 8.0 中移除: The
--no-use-make-mode
option. The--use-make-mode
now has no effect.
- --makefile, --no-makefile¶
创建(或不创建)makefile。
- --batchfile, --no-batchfile¶
创建(或不创建)批处理文件
项目模板
在版本 1.5 中添加: sphinx-quickstart 的项目模板选项
- -t, --templatedir=TEMPLATEDIR¶
模板文件的模板目录。您可以修改 quickstart 生成的 sphinx 项目文件的模板。以下 Jinja2 模板文件是允许的
root_doc.rst.jinja
conf.py.jinja
Makefile.jinja
Makefile.new.jinja
make.bat.jinja
make.bat.new.jinja
详细说明,请参考 Sphinx 提供的系统模板文件。(
sphinx/templates/quickstart
)
- -d NAME=VALUE¶
定义一个模板变量
另请参阅¶
sphinx-build(1)