Sphinx快速启动

简介

sphinx-quickstart

描述

sphinx-quickstart 是一个交互式工具，它询问关于您的项目的一些问题，然后生成一个完整的文档目录和用于 sphinx-build(1) .

选项

-q, --quiet

向导将跳过指定该静默模式的选项。此选项需要 -p ， -a 和 -v 选项。

-h, --help, --version

显示使用摘要或Sphinx版本。

结构选项

--sep

如果指定，请分离源目录和生成目录。

--no-sep

如果指定，则在源目录下创建生成目录。

--dot=DOT

在根目录中，将再创建两个目录；自定义HTML模板为“模板”，自定义样式表和其他静态文件为“静态”。您可以输入另一个前缀（如“.”）来替换下划线。

项目基本选项

-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

启用任意扩展。

生成文件和批处理文件创建选项

--use-make-mode (-m), --no-use-make-mode (-M)

Makefile/make.bat 使用（或不使用） make-mode . 默认是 use ，这将生成更简洁的 Makefile/make.bat .

在 1.5 版本发生变更: 默认为生成模式。

在 7.3 版本发生变更: 在Sphinx 8中将删除对禁用Make模式的支持。

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