HTMLしたい(sphinx-build)
# -b html: 標準的なHTML出力(UglyURL形式)
$ sphinx-build -b html source build/html
# -b dirhtml: ディレクトリベースのHTML出力(PrettyURL形式)
$ sphinx-build -b dirhtml source build/dirhtml
# -b singlehtml: 単一HTMLファイル出力
$ sphinx-build -b singlehtml source build/singlehtml
sphinx-buildコマンドでHTML形式で出力できます。
HTMLしたい(make html)
$ make html
$ make dirhtml
$ make singlehtml
sphinx-quickstartで初期化するとドキュメントにはMakefileが自動生成されます。
Makefileがあるディレクトリでmake htmlを実行するとHTML形式で出力できます。
生成したファイルはbuild/html/以下に出力されます。
URLはいわゆるUglyURL形式で生成されます。
1$ cd $MyPROJECT/docs/
2$ make html
3$ open build/html/index.html
PrettyURLしたい(make dirhtml)
1$ cd $MyPROJECT/docs/
2$ make dirhtml
3$ open build/dirhtml/index.html
PrettyURL形式にしたい場合はmake dirhtmlを使います。
ヒント
ローカル開発でmake dirhtmlしたファイルを開くと、ディレクトリの中身が表示されます。
これは、URLの末尾が/になっているときにindex.htmlへリダイレクトされるのはサーバーの機能です。
なので、ローカルでビルドする場合はmake htmlがオススメです。
リファレンス
- HTML出力のオプション - Sphinxドキュメント
ウェブページを生成するときのオプションを確認するときに参照します。頭から読んでもあまり参考にならず、「〇〇したいから設定ないかなぁ」と逆引きする使い方がよいと思います。