ライオンの顔像-クイック入門

要綱.

sphinx-quickstart

説明する.

sphinx-quickstart プロジェクトに関する質問をし、一緒に使用するための完全な文書ディレクトリおよび例示的なMakefileを生成する対話型ツールである。 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

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

構造オプション

--sep

指定された場合は、ソースディレクトリと構築ディレクトリを分けてください。

--no-sep

指定された場合は、ソースコードディレクトリの下に構築ディレクトリを作成します。

--dot=DOT

ルートディレクトリ内では、“_Templates”はHTMLテンプレートをカスタマイズするために使用され、“_Static”はカスタムスタイルテーブルおよび他の静的ファイルのために他の2つのディレクトリが作成される。“.”のような別の接頭辞を入力することができます。下線を置き換える。

プロジェクト基本オプション

-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

主文文書名。(会いましょう) 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 で追加: Shinxのプロジェクトテンプレートオプション-クイックスタート

-t, --templatedir=TEMPLATEDIR

テンプレートファイルのテンプレートディレクトリ。QuickStartによって生成されたShinxプロジェクトファイルのテンプレートを修正することができます。以下のJJIA 2テンプレートファイルの使用が許可されています。

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