Sphinxの環境を整える
id:rokujyouhitoma さんに誘われてPyPyの翻訳を始めました。
PyPy本家の資料がSpinxで書かれているため、翻訳ももちろんSphinxで行っています。
インストールするパッケージ
Sphinxの導入
Sphinxの実行環境をつくるを参考にしてbuildoutでSphinxをインストールする。
Pythonは標準で入っているものを使えばok.
↓みたいにaliasでsphinx-buildのパスを設定しておくとベター
alias shinx-build='/path/to/sphinx-build'
OMakeの設定
OMakeってなに?って人はこちらを見ると良いかと => OMake つかったらC言語でプログラム書く手間がバカみたいに減った - 日記を書く [・w・] はやみずさん
継続監視ビルド(対象ファイルが変更されるたびにビルド)ができるのが強みみたいですね。
OMakeはUbuntuならばapt,MacならばMacportsなどで導入が可能です。
Sphinxの魔法にかかってみた - ふぞろいのGENGOたちに詳しい設定方法も書いているので読むのがおすすめ。
私が使ってるOMakeファイルは以下です。
# OMakefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build BUILDDIR = _build # Internal variables. ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . SRCS = $(find . -name *.rst) .DEFAULT: $(SRCS) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
まとめ
Sphinxはユーザー会の方々が熱心に布教されているおかげで設定記事がたくさんあって助かりました。
今後は仕事でも使って行きたいなと思います。
先人の皆様に感謝いたします。
PyPyに興味がある方、是非一緒に翻訳をしませんか?興味のある方は id:rokujyouhitomaさんに一声かけるといいと思います。