[sphinx] "make html" を自動化する方法

sphinx の便利さにハマって以来、ほとんどのドキュメントを sphinx で作っているのですが、１つだけ不便なことがあります。

それは、HTML化するために毎回

 $ make html

を実行しないといけないことです。

これが何気にめんどくさい。

編集して、保存んしたら勝手にHTMLも更新してほしいなぁと思ったので、ちょっと調べてみました。

そしたら、ありました！

それは「sphinx-autobuild」を利用する方法です。

sphinx-autobuild を利用してビルドを自動化する

sphinx-autobuild を利用すれば、rstファイルを変更した時点で自動ビルドが走り、ブラウザに反映されるようになります。



1. sphinx-autobuildをインストールする

 $ pip install sphinx-autobuild

2. Makefile に target を追加する

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

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

$ make livehtml

4. ブラウザで「http://127.0.0.1:8000/」を開く


これで、rstファイルを編集して保存すると、自動的にビルドが実行されhtmlが更新されます。