ライオンの顔像-Build

要綱.

sphinx-build [options] <sourcedir> <outputdir> [filenames ...]

説明する.

sphinx-build そこからの文書生成文書 <sourcedir> それを入れて <outputdir> それがそうです。

sphinx-build 探す <sourcedir>/conf.py 設定を構成するために使用される。 sphinx-quickstart(1) テンプレートファイルを生成するために使用することができる conf.py それがそうです。

sphinx-build 異なるフォーマットの文書を作成することができます。フォーマットは、コマンドライン上でビルダ名を指定することによって選択され、HTMLとしてデフォルトである。ビルダはまた，文書処理に関する他のタスクを実行することができる.

デフォルトでは，期限切れのすべてのコンテンツが構築される.単一のファイル名を指定することで，選択されたファイルの出力しか生成できない.

利用可能なオプションのリストについては、ご参照ください sphinx-build -b それがそうです。

オプション

-b buildername

最も重要なオプション：それは構築器を選択する。最も一般的な建築業者は

html

HTMLページを構築する.これはデフォルトの構築器です。

dirhtml

HTMLページを構築するが，各文書には1つのディレクトリしかない.URLをもっときれいにします(No .html )は、ネットワークサーバから提供されれば。

singlehtml

全コンテンツを含む単一のHTMLを構築する.

htmlhelp, qthelp, devhelp, epub

これらのフォーマットの1つで文書集合を構築するために，付加情報を用いてHTML文書を構築する.

applehelp

リンゴヘルプマニュアルを作成します。要求 hiutil そして codesign これらはオープンソースではなく、現在はMac OS X 10.6以降でのみ利用可能です。

latex

PDF文書にコンパイルされたLaTeXソースコードの構築 pdflatex それがそうです。

man

UNIXシステムのためにGroff形式のマニュアルページを構築する.

texinfo

Infoファイルとして処理可能なTexinfoファイルの構築を使用して makeinfo それがそうです。

text

プレーンテキストファイルを構築する.

gettext

Gettextスタイルを構築するメッセージ·ディレクトリ (.pot 書類)です。

doctest

文書内の全ての文書テストを実行すれば doctest 拡張は有効になりました。

linkcheck

すべての外部リンクの完全性をチェックする.

xml

Docutils-ネイティブXML文書を構築する.

pseudoxml

コンパクトで美しい“擬似XML”ファイルを構築し，中間文書木の内部構造を表示する.

見 建設者. ライオンの顔像に添付されているすべての構築者のリストについて。拡張は自分の構築器を追加することができる。

-M buildername

代わりに -b それがそうです。ライオンの顔像を使って make_mode デフォルト生成機能と同様の生成機能を提供するモジュール. Makefile or Make.bat それがそうです。ライオンの顔を除いて 建設者. 以下を用いてパイプを構築することができる.

latexpdf

LaTeXファイルを構築して実行します pdflatex 押したり押したり latex_engine セット。もし language とする. 'ja' 自動的に使用されます platex/dvipdfmx LaTeXからPDFへのパイプ。

info

Texinfoファイルを構築し、それらを実行します。 makeinfo それがそうです。

重要

Sphinxは識別するだけです -M 選択肢(それが第1位に置かれている場合)。

バージョン 1.2.1 で追加.

-a

所与の場合、すべての出力ファイルを常に書き込むようにしてください。デフォルトでは、新しいソースファイルおよび変更されたソースファイルの出力ファイルのみが書き込まれます。(これはすべての建築業者には適用されないかもしれません。)

-E

保存されているものを使わないでください environment (すべての交差参照の構造をキャッシュする)が，それを完全に再構成する.デフォルトでは、前回の実行以来新しいまたは変更されたソースファイルのみが読み出され、解析されます。

-t tag

マークを定義する tag それがそうです。これは only このフラグが設定されていれば，その内容の命令のみを含む.

バージョン 0.6 で追加.

-d path

Sphinxは出力ファイルを書き込む前にすべてのソースファイルを読み出して解析しなければならないため，解析後のソースファイルは“doctree picle”としてキャッシュされる.通常これらの文書は .doctrees Buildディレクトリの下で；このオプションを使用して、異なるキャッシュディレクトリを選択することができます(ドキュメントツリーはすべてのビルダ間で共有できます)。

-j N

構築は以下の位置に配布されます N 並列プロセスは，マルチプロセッサ計算機上でより効率的に構築される.Sphinxのすべての部分およびすべてのビルダが並列化できるわけではないことに注意されたい。もし auto パラメータの場合，SphinxはCPU数を用いる. N それがそうです。

バージョン 1.2 で追加: この選択肢を考慮すべきだ 試験的に それがそうです。

バージョン 1.7 で変更: 支持する. auto 論争する。

-c path

そんなものを探しに行かないで conf.py ソースディレクトリでは，与えられた構成ディレクトリに変更する.なお、構成値によって提供される様々な他のファイルやパスは、構成ディレクトリに対して予想されるため、これらもこの位置に出現しなければならない。

バージョン 0.3 で追加.

-C

プロファイルを探すな -D 選択します。

バージョン 0.5 で追加.

-D setting=value

設定された構成値の書き換え conf.py ファイルです。値は、数字、文字列、リスト、または辞書値でなければなりません。

リストの場合、以下のようにコンマ分離要素を使用することができます。 -D html_theme_path=path1,path2 それがそうです。

辞書値については、以下のように設定名とキーを提供してください。 -D latex_elements.docclass=scrartcl それがそうです。

ブル値については、ご利用ください 0 あるいは…。 1 その価値のように。

バージョン 0.6 で変更: この値は、現在、辞書値とすることができる。

バージョン 1.3 で変更: この値は現在リスト値であってもよい.

-A name=value

これを name 分配する. 値 HTMLテンプレートの中で。

バージョン 0.5 で追加.

-n

難癖モードで動作する。現在、これはすべての不足している参照のための警告を生成するだろう。構成値の表示 nitpick_ignore “既知の損失”と呼ばれるいくつかの参照を排除するための方法を探す。

-N

カラー出力を発射しないでください。

-v

詳細度(ログレベル)を増加させる.このオプションは、より多くのデバッグログ出力を得るために最大3回提供することができます。これは私たちが -T それがそうです。

バージョン 1.2 で追加.

-q

標準出力に何も出力するのではなく，警告とエラーのみを標準エラーに書き込む.

-Q

標準出力に何も出力しないで、警告も表示しないでください。エラーだけが標準エラーに記入されます。

-w file

標準エラーに加えて，与えられたファイルに警告(およびエラー)を書き込む.

-W

警告を誤りにする。これは1回目の警告時に構築が停止し、 sphinx-build 脱退状態が1の脱退.

--keep-going

-Wオプションを用いて，警告を受信して構築終了まで処理を継続し， sphinx-build 脱退状態が1の脱退.

バージョン 1.8 で追加.

-T

未処理の例外が発生した場合には完全なバックトラックを示す.そうでなければ、要約のみが表示され、さらなる分析のためにバックトラック情報がファイルに保存される。

バージョン 1.2 で追加.

-P

(デバッグにのみ適用されます。)Pythonデバッガを実行して pdb 生成中に未処理の例外が発生した場合は戻る.

-h, --help, --version

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

バージョン 1.2 で追加.

コマンドラインでソースコードおよびディレクトリを構築した後に1つまたは複数のファイル名を指定することもできます。そして，Sphinxはこれらの出力ファイル(およびその依存項)のみを構築しようと試みる.

環境変数

♪the sphinx-build 以下の環境変数である.

MAKE

1本の命令を出す経路。命令名も許される. sphinx-build これを用いて生成パターンに子生成過程を呼び出す.

Makefileオプション

♪the Makefile そして make.bat 文書作成者 sphinx-quickstart 通常運行する. sphinx-build 適用されるのは -b そして -d 選択します。しかし，これらは以下の変数をカスタマイズするための行為をサポートする：

PAPER

これは設定されます 'papersize' のキーワードです。 latex_elements ：すなわち PAPER=a4 これを 'a4paper' そして PAPER=letter 至る 'letterpaper' それがそうです。

注釈

Sphinx 1.5ではこの環境変数の使い方が破壊されています a4 あるいは…。 letter 最終的には必要ではなくLaTeX文書の選択肢になります a4paper それぞれ，以下のとおりである. letterpaper それがそうです。1.7.7に固定した.

SPHINXBUILD

使用する命令ではなく sphinx-build それがそうです。

BUILDDIR

使用する生成ディレクトリは，中で選択された生成ディレクトリではない. sphinx-quickstart それがそうです。

SPHINXOPTS

他のオプションは sphinx-build それがそうです。ショートカット変数でこれらのオプションを設定することもできます O (大文字‘o’)。

警告のご利用はおすすめしておりません

使用を推奨しない警告があれば RemovedInSphinxXXXWarning ユーザ文書を構築する際には，いくつかのSphinx拡張が使用を推奨しない特性を使用していることを示している.この場合、内線の著者に報告してください。

投棄警告を無効にするには、設定してください PYTHONWARNINGS= 環境変数はあなたの環境に設定されています。例：

• PYTHONWARNINGS= make html (Linux/Mac)

• export PYTHONWARNINGS= そしてやります make html (Linux/Mac)

• set PYTHONWARNINGS= そしてやります make html (窓口)

• Makefile/make.batを変更し、環境変数を設定する

また見られる.

sphinx-quickstart(1)