sphinx-quickstart

概要

sphinx-quickstart

描述

sphinx-quickstart 是一個互動式工具，會詢問您一些關於專案的問題，然後產生一個完整的文件目錄和範例 Makefile，以搭配 sphinx-build(1) 使用。

選項

-q, --quiet

安靜模式，會跳過用於指定選項的互動式精靈。此選項需要 -p、-a 和 -v 選項。

-h, --help, --version

顯示使用方式摘要或 Sphinx 版本。

結構選項

--sep

如果指定，則分隔來源目錄和建置目錄。

--no-sep

如果指定，則在來源目錄下建立建置目錄。

--dot=DOT

在根目錄內，將建立另外兩個目錄；用於自訂 HTML 範本的 “_templates” 和用於自訂樣式表和其他靜態檔案的 “_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: 在 Sphinx 8 中將移除對停用 make-mode 的支援。

移除於版本 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)