狮身人面像-快速入门

提纲

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

启用任意扩展。

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

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

Makefile/make.bat 使用(或不使用) make-mode 。缺省值为 use ,这会生成一个更简明的 Makefile/make.bat

在 1.5 版本发生变更: 默认设置为Make-模式。

--makefile, --no-makefile

创建(或不创建)Makefile。

--batchfile, --no-batchfile

创建(或不创建)批处理文件

项目模板

在 1.5 版本加入: Shinx的项目模板选项-快速入门

-t, --templatedir=TEMPLATEDIR

模板文件的模板目录。您可以修改由快速入门生成的狮身人面像项目文件的模板。允许使用以下JJIA2模板文件:

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