SSブログ

Github Pages と sphinxtogithub パッケージ [Python]

(第20回)Python mini Hack-a-thon の記録

pyfirebirdsql http://pypi.python.org/pypi/firebirdsql/0.7.0 のドキュメントを修正をした。主に changelog 。

KInterbasDB のドキュメント↓が sphinx のドキュメントになっていて
http://www.firebirdsql.org/file/documentation/drivers_documentation/python/3.3.0/index.html
mariz さんと言う方が pyfirebirdsql 用に修正してくれた。
というわけで、 sphinx のソースとしてドキュメントができた(ありがたい)

一方、github には Github Pages という静的な HTML でドキュメントを公開できる仕組みが用意されている。 gh-pages というブランチのディレクトリのルートに index.html をおくと http://[username].github.com/[project_name]/ でアクセスできる
https://github.com/nakagami/pyfirebirdsql
この↑プロジェクトのドキュメントがここ↓
http://nakagami.github.com/pyfirebirdsql/

・・・が、普通に sphinx のドキュメントから make html すると、うまくできないらしいので sphinxtogithub というパッケージをインストールして、 conf.py の extensions に設定してますよ、という話。ここ↓にあるものがすべて
http://d.hatena.ne.jp/kuma8/20110925/1316937363
コメント(0)  トラックバック(0) 

コメント 0

コメントを書く

お名前:
URL:
コメント:
画像認証:
下の画像に表示されている文字を入力してください。

※ブログオーナーが承認したコメントのみ表示されます。

Facebook コメント

トラックバック 0