付録BSphinxが使える出力形式

Sphinxは、この本で紹介した以外にも多くの出力形式(ビルダー)に対応しています。ここではSphinxが標準で使えるビルダーを紹介します。これらのビルダーは make <builder名> コマンドで使用できます。

B.1 本書で説明したビルダー

html

HTML形式で出力します。

epub

EPUB形式で出力します。

latex

LaTeXファイルとして出力します。

latexpdf

LaTeXファイルとして出力した後、TeXを実行しPDFファイルに変換します。

B.2 HTML

singlehtml

ドキュメントをひとつに結合した後に、HTML形式で出力します。

dirhtml

ドキュメントをサブディレクトリごとに結合した後に、HTML形式で出力します。

B.3 ヘルプブラウザ

htmlhelp

Windows用のヘルプ形式(HTML help)で出力します。

qthelp

Qtアプリケーション用のヘルプ形式(qthelp)で出力します。

devhelp

GNOMEアプリケーション用のヘルプ形式(devhelp)で出力します。

man

UNIX系OSのオンラインマニュアル形式(man page)で出力します。

texinfo

GNU Texinfo形式で出力します。

info

GNU Texinfo形式で出力した後、 makeinfo コマンドを実行しInfoファイルに変換します。

B.4 内部データ構造

pickle

pickle形式(Pythonの内部データ形式)で出力します。

json

JSON形式で出力します。実際の文字情報は"body"というキーにHTML形式で格納されています。