sphinx-build

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

sphinx-build は設定を <sourcedir>/conf.py から探します。

デフォルトでは更新されたファイルだけがビルドされます。個々のファイルを指定すると、その選択されたファイルだけが出力されます。

-M buildername

Alternative to -b.

-b buildername

ビルダーを選択する、もっとも重要なオプションです。

Since Sphinx has to read and parse all source files before it can write an output file, the parsed source files are cached as “doctree pickles”.

「Sphinxは出力ファイルに書く前にすべてのソースファイルを読んでパースしなければならないので、パースされたソースファイルは"doctree pickle"としてキャッシュされる」

通常は、これらのファイルはビルドディレクトリの下の .doctrees と呼ばれるディレクトリに置かれます。このオプションを指定すると、キャッシュディレクトリを違う場所に設定できます。

doctreeはすべてのビルダーで共有されます。

conf.py ファイルで設定されたコンフィグを上書きします。

捕捉されない例外が発生した時、完全なトレースバックを表示します。

このオプションがない場合、要約だけが表示され、トレースバックの情報は今後の解析のためにファイルとして保存されます。

(Sphinx自体のデバッグをする人用) キャッチされない例外がビルド中に発生したら、Pythonデバッガの pdb を実行します。

Distribute the build over N processes in parallel, to make building on multiprocessor machines more effective.

値としてautoも指定できる

警告をエラーにします

Makefileについてもドキュメントがある（TODO）