sphinx-quickstart¶

概要¶

sphinx-quickstart

Description¶

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 skips the interactive wizard for specifying options. This option requires -p, -a and -v options.

-h, --help, --version¶: Display usage summary or Sphinx version.

Structure Options

--sep¶: If specified, separate source and build directories.

--no-sep¶: If specified, create build directory under source directory.

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

Project Basic Options

-p PROJECT, --project=PROJECT¶: Project name will be set. (see project).

-a AUTHOR, --author=AUTHOR¶: Author names. (see copyright).

-v VERSION¶: 專案的版本。（請參見 version）。

-r RELEASE, --release=RELEASE¶: 專案的發行版。（請參見 release）。

-l LANGUAGE, --language=LANGUAGE¶: 文件語言。（請參見 language）。

--suffix=SUFFIX¶: Source file suffix. (see source_suffix).

--master=MASTER¶: Master document name. (see 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¶: Enable arbitrary extensions.

Makefile and Batchfile Creation Options

--use-make-mode (-m), --no-use-make-mode (-M)¶: Makefile/make.bat uses (or doesn't use) make-mode. Default is use, which generates a more concise Makefile/make.bat.

在 1.5 版的變更: make-mode is default.

在 7.3 版的變更: Support for disabling the make-mode will be removed in Sphinx 8.

在 8.0 版被移除: The --no-use-make-mode option. The --use-make-mode now has no effect.

--makefile, --no-makefile¶: Create (or not create) makefile.

--batchfile, --no-batchfile¶: Create (or not create) batchfile

Project templating

在 1.5 版被加入: Project templating options for sphinx-quickstart

-t, --templatedir=TEMPLATEDIR¶

Template directory for template files. You can modify the templates of sphinx project files generated by quickstart. Following Jinja2 template files are allowed:

root_doc.rst.jinja
conf.py.jinja
Makefile.jinja
Makefile.new.jinja
Makefile.new.jinja
make.bat.new.jinja

In detail, please refer the system template files Sphinx provides. (sphinx/templates/quickstart)

-d NAME=VALUE¶: Define a template variable

另請參見¶

sphinx-build(1)