読者です 読者をやめる 読者になる 読者になる

Block Rockin’ Codes

back with another one of those block rockin' codes

bitbucketにSphinxをホスティング

Sphinx bitbucket

今回、jsonengine - Simple and ultra-scalable JSON storage on Google App Engine. No server-side coding required. - Google Project Hostingというプロジェクトのマニュアルを、日本語翻訳させて頂いたんですが、作成した翻訳(Sphinxプロジェクト)をどこに公開するかで悩んでいました。

選択肢としては、

なんか考えられるんですが、その辺をつぶやいていたら、GithubやBitbucketを使ったホスティングの方法についてアドバイスを頂けたのでちょっとやってみました。


今回はBitbucketを用いたホスティングする事にしたのですが、あまりにも簡単だったので紹介します。

Bitbucketでの静的ファイルのホスティング

Free Hosting at BitBucket / hg tip こちらにある通りです。
まず、Bitbucketに USERNAME.bitbucket.org という名前のリポジトリを作成します。
自分の場合は、 jxck.bitbucket.org です。
このリポジトリは、直下に置いた index.html に対して、
http://jxck.bitbucket.org/でアクセスできるようになります。


ここまで言えば多くの人には用が足りるかもしれません。あとはリンク関係は相対パスで通るので、必要な階層構造でファイルをコミットすれば、それだけでこのドメイン以下で静的ファイルファイルを公開する事ができます。

Sphinx を公開する

Sphinx はドキュメント作成ツールです。reSt(restructured text)で記述されたファイルをビルドする事で、様々な形式のドキュメントを作る事ができます。
HTML形式でビルドする事でそのまま公開できるドキュメントサイトも作成できます。
詳しい使い方等は、Sphinx-Users.jp — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会Overview — Sphinx v1.0 (hg) documentationに譲りますが、今回はもこれを使って作成しました。


SphinxSphinx-quickstart でプロジェクトの雛形が作れるのですが、この時、「ソースファイルとビルドファイルを分ける」ように設定をしておくと、ビルドしたファイルがbuildディレクトリにまとまります。
htmlの場合は、この下にhtmlディレクトリができるので、その中のindex.htmlが見れれば良い。
そこで今回は以下のような構成で作成しました。

username.bitbucket.org
  |_.hg
  |_index.html
  |_jsonengine-doc-ja
     |_build
       |_html
         |_ ...


hg pushだけでデプロイできる、超簡単ホスティングサーバということですね。

githubも同様の事ができるそうです。GitHub Pages
公開できるリポジトリは、各ユーザに対して一つしか作れないみたいですが、ちょっとしたホスティングにはとても重宝すると重います。
普段使っているリポジトリなら、なおさら便利じゃないかと思います。
bitbucketはたまに応答が無くなる場合が有るのでその点の懸念は有るかもしれませんが、それにつけても無料でこれだけのことができるんですから十分過ぎるくらいです。ありがたく使わせて頂きます。


最後に今回公開したドキュメントです。


jsonengine 日本語ドキュメント — jsonengine-manual-ja v0.1 documentation