sphinx-quickstart

概要

sphinx-quickstart

描述

sphinx-quickstart is an interactive tool that asks some questions about your project and then generates a complete documentation directory and sample Makefile to be used with sphinx-build(1).

选项

-q, --quiet

Quiet mode that will skip interactive wizard to specify options. This option requires -p, -a and -v options.

-h, --help, --version

显示使用情况摘要或Sphinx版本.

Structure Options

--sep

如果指定,则单独的源和构建目录.

--dot=DOT

Inside the root directory, two more directories will be created; “_templates” for custom HTML templates and “_static” for custom stylesheets and other static files. You can enter another prefix (such as “.”) to replace the underscore.

项目基本选项

-p PROJECT, --project=PROJECT

项目名称将被设置. (见:confval:project).

-a AUTHOR, --author=AUTHOR

作者姓名. (见:confval:copyright).

-v VERSION

作者姓名.(See: confval: copyright).

-r RELEASE, --release=RELEASE

发布项目.(see release).

-l LANGUAGE, --language=LANGUAGE

文档语言.(see language).

--suffix=SUFFIX

源文件后缀.(see source_suffix).

--master=MASTER

主文档名称.(see master_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. 默认是``use``,它生成一个更简洁的 Makefile/make.bat.

在 1.5 版更改: make-mode 是默认的.

--makefile, --no-makefile

创建(或不创建)makefile.

--batchfile, --no-batchfile

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

项目模板

1.5 新版功能: sphinx-quickstart的项目模板选项

-t, --templatedir=TEMPLATEDIR

模板文件的模板目录.您可以修改快速入门生成的sphinx项目文件的模板.允许使用以下Jinja2模板文件:

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