SphinxのMakefileをいじる
前回の記事 gritを使ってgitを自動で操作してみる。 - 鶏頭のプログラム でも書きましたが。
今回はgitでsphinxで書かれたドキュメントを管理しています。
そして今回の記事ではsphinxディレクトリ以下のファイルにどのような内容の手を加えたのかを説明します。
ディレクトリ構成
├── Gemfile ├── compile.rb ├── config.ru ├── route.rb ├── log │ ├── access.log │ └── error.log ├── public │ └── sphinxでmakeしたhtmlファイルを配置 └── sphinx └── documents ├── .git └── server ├── Makefile ├── copy.py ├── index.rst └── その他ファイル
この中で今回私が手を加えたのは copy.py と Makefile です。
copy.py では
language = 'ja'
を記入しただけですが
Makefileにおいては
$ make server
を通るように修正しました。たいそうなことをした訳ではなく、publicディレクトリにコンパイルされたファイルが
できるようにしただけです。
SPHINXBUILD = sphinx-build BUILDDIR_FOR_SERV = ../../../public/documents ALLSPHINXOPTS_SRV = -d $(BUILDDIR_FOR_SERV)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . server: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS_SRV) $(BUILDDIR_FOR_SERV)/html
を追加しただけです。
これで
$ make server
すれば自動的に public/documents 以下にコンパイルされたhtmlファイルが配置されるようになります。
あとは index.rst ファイルなどに
`コンパイル </compile>`_
を記載しておけば、クリックするだけで自動的にgitからpullされ
make serverが実行されてファイルが置き換わるようになります。