Sphinxでのドキュメント作成をそれなりに快適に書く方法

前回書いた通り、ドキュメント作成にSphinxを使い始めています。

Markdownと違って単一のページを書くのはちょっと大仰な感じしますが、体系的なドキュメント書くのには構造がしっかりしている分いい感じ。

ところがMarkdownと違って書いてプレビューしたいなと思う度に make html するのは辛い。しかもその後ブラウザで開く必要あり。開いていてもリロード。

これではSphinx始めたてで、文法と文書がリンクできない人間にはちょっとつらい。

前回、コマンド一発でhtmlが吐かれるところまではできています。

これはあんまり苦じゃありません。そこまでbuildが遅いわけでもないので。大体1秒もあれば終わる。

あとはこれを自動でプレビューし変更を感知してリロードしてくれればそれなりに書ける環境が出来上がるのではないか。

そこで、いい感じのツールを見つけました。

npm install -g livereloadx でlivereloadxをインストール。

ブラウザ拡張入れたり、jsを全ページに入れるのは面倒なのでstaticモードで実行します。

livereloadx -s document/_build/

を実行。

その後に

にアクセスすると作られたドキュメントがプレビューされます。

あとは.rstなドキュメントを書いて、Sublime上でショートカットでbuild。ブラウザはファイルの変更を検知して自動でリロードをかけてくれるので最新の状態が手軽にプレビューすることができます。

これで大分Sphinxでドキュメント書くのが楽しくなりそうです。