sphinx-quickstart

概要

sphinx-quickstart

説明

sphinx-quickstart は、プロジェクトに関するいくつかの質問をして、sphinx-build(1) で使用される完全なドキュメントディレクトリとサンプル Makefile を生成する対話型ツールです。

オプション

-q, --quiet

オプションを指定するための対話型ウィザードをスキップする静音モード。このオプションには、-p、-a、-v オプションが必要です。

-h, --help, --version

使用方法の概要または Sphinx のバージョンを表示します。

構造オプション

--sep

指定した場合、ソースディレクトリとビルドディレクトリを分離します。

--no-sep

指定した場合、ソースディレクトリの下にビルドディレクトリを作成します。

--dot=DOT

ルートディレクトリ内に、さらに2つのディレクトリが作成されます。カスタム 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)