sphinx でファイル保存時に自動でビルドする方法

Sphinx でドキュメントを作成するときに、html化する場合は、以下のコマンドを実行します。

$ make html

ただ、ファイルを変更するたびにコマンドを実行するのは正直めんどくさい。

ということで、ファイルを保存したら自動的にビルドしてhtml化してくれるようにしてみます。

sphinx-autobuild を利用する

「sphinx-autobuild」を利用することで、rstファイルを変更して保存した時点で自動的にコマンドを実行して、ブラウザ上で確認できるようにします。

１．sphinx-autobuildをインストールする

$ pip install sphinx-autobuild

２．Makefile に target を追加する

livehtml:
    sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

３．SphinxのMakefileがあるディレクトリで以下のコマンドを実行する

$ make livehtml

４．ブラウザで「http://127.0.0.1:8000/」を開く

Sphinxで作成したドキュメントを日本語で検索する

私は、ドキュメントの作成に Sphinx を使用していますが、Sphinx で作成したドキュメントには検索機能がついていますが、英語しか対応していなくて不便だなぁと思っていたら、

sphinx 1.1.2 で日本語にも対応していたようです。

conf.pyに以下の記述を追加します。

html_search_language = 'ja'