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 和批处理文件创建选项

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

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

版本 1.5 中已更改: make-mode 成为默认。

版本 7.3 中已更改: 对禁用 make-mode 的支持将在 Sphinx 8 中移除。

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