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”用于自定义样式表及其他静态文件。你可以指定不同的前缀（比如“.”）代替下划线。

项目基本选项

-p PROJECT, --project=PROJECT

设置项目名称。（参见 project）。

-a AUTHOR, --author=AUTHOR

作者名字。（参见 copyright）。

-v VERSION

项目版本。（参见 version）。

-r RELEASE, --release=RELEASE

发布项目。（参见 release）。

-l LANGUAGE, --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 使用（或不使用） make-mode 。默认值是 使用，这会生成一个更加简明的 Makefile/make.bat 文件。

在 1.5 版本发生变更: 默认为使用 make-mode。

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

在版本 8.0 移除: --no-use-make-mode 选项。--use-make-mode 现在无效。

--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)