HTMLしたい(make html
)
1$ make html
2$ make dirhtml
3$ make singlehtml
ウェブページを生成するときはmake 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ドキュメント
ウェブページを生成するときのオプションを確認するときに参照します。頭から読んでもあまり参考にならず、「〇〇したいから設定ないかなぁ」と逆引きする使い方がよいと思います。