sphinx-快速入门¶

概要¶

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”用于自定义样式表和其他静态文件.您可以输入另一个前缀（例如”.”）来替换下划线.

项目基本选项

-p PROJECT, --project=PROJECT¶: 项目名称将被设置.（参见 project）.

-a AUTHOR, --author=AUTHOR¶: 作者姓名.（见 版权）.

-v VERSION¶: 项目版本.（参见 version）.

-r RELEASE, --release=RELEASE¶: 项目发布.（见 release）.

-l LANGUAGE, --language=LANGUAGE¶: 文档语言.（参见 语言）.

--suffix=SUFFIX¶: 源文件后缀.（参见 source_suffix）.

--master=MASTER¶: 主文档名称.（参见 root_doc）.

扩展选项

--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 和 Batchfile 创建选项

--use-make-mode (-m), --no-use-make-mode (-M)¶: Makefile/make.bat 使用（或不使用）:ref:make-mode <make_mode>.默认是 use,这将生成一个更简洁的 Makefile/make.bat.

在 1.5 版本发生变更: make-mode 是默认模式.

在 7.3 版本发生变更: 在 Sphinx 8 中将移除禁用 make-mode 的支持.

Removed in version 8.0: The --no-use-make-mode 选项.The --use-make-mode 现在没有效果.

--makefile, --no-makefile¶: 创建（或不创建）makefile.

--batchfile, --no-batchfile¶: 创建（或不创建）批处理文件

项目模板

Added in version 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)