期せずして Read The Doc を使い始めた

昨日の Python mini Hack-a-thon でやりかけた pyfirebirdsql の修正が終わったので、今日リリースした。
https://pypi.python.org/pypi/firebirdsql/0.7.3

・・・が、ここで問題発生。
ドキュメントを sphinxtogithub で HTML にして GitHub Pages として公開していたのだが、
http://nakagami.blog.so-net.ne.jp/2012-06-23

ここにきて Shpinx と sphinxtogithub を新環境でインストールして make html しようとしたら途中でエラーになることが発覚。
sphixtogithub は、もう長いことメンテナンスされてなくて、以前は python2.5 の環境で動かしていたのがが、もう　python と Shpinx と sphinxtogithub のどの組み合わせが動いていたのかよくわかんない。

GitHub Pages でドキュメントを公開するためには gh-pages というブランチをメンテナンスしなくちゃいけなくて、Shpinx のドキュメントは master ブランチにも持っているのに、いちいち公開するドキュメントのためだけに gh-pages ブランチをメンテナンスしなくちゃいけなくて、面倒だなー、と思っていた。

Shpinx ドキュメントのホスティングサービスとして Read The Docs というのがあるというのは知っていたので、それでドキュメントを公開できないか調べてみた。

https://readthedocs.org/ でアカウントを作って Dashboard で Imoprt で、以下のようなところを設定

- Name: （プロジェクト名 pyfirebirdsql）
- Repo: （リポジトリパス 今回は git://github.com/nakagami/pyfirebirdsql.git）
- Repository type: (GitHub なので Git を選択）
- Language: （今回は English）
- Default branch: （今回は master）
- Default version: （latest）
- Python configuration file: （conf.py のパス。今回は sphinx/conf.py ）
- Python interpreter: (Python 2.x)
- Document type: (Sphinx Html)

で Create をしたら、なんか、うまいこと公開された。
思ったより簡単だし、 master リポジトリのファイルで一元管理できるので、もっと早くやっておけば良かったよ。

GitHub Pages は使わなくなったので gh-pages ブランチは削除した