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

YAMAGUCHI::weblog

土足で窓から失礼いたします。今日からあなたの息子になります。 当年とって92歳、下町の発明王、エジソンです。

bitbucketを使ってSphinxのソースを管理

動機

この間翻訳で使ってみたらかなり使いやすかったんで始めてみた。これからドキュメント書きに使いそうなのでメモ。

手順

レポジトリの準備

bitbucketでMercurialのプロジェクトを作成する。
f:id:ymotongpoo:20091005221031p:image
f:id:ymotongpoo:20091005221028p:image
これでプロジェクトができた。今度はローカルにcloneする。

$ hg clone hg clone http://bitbucket.org/<username>/<repository name>

ここでbitbucketで幸せになるために設定ファイルを修正する。

$ cd <repository name>
$ vim .hg/hgrc
+ [ui]
+ username = hogehoge <foo AT example.com>

usernameを変更しておかないとbitbucketにpushしたときに登録したメールアドレスがそのまま表示されてしまい、botから丸見えな状態らしい。
あと_buildディレクトリは追加すると毎回とんでもない数のHTMLファイルがコミットされる恐れがあるので、これも無視するようにしてしまいます。

$ cd <repository top>
$ vim .hgignore
syntax: glob
_build

これでhg stしたときに大量のHTMLファイルがでなくてすみます。

Sphinxで作成

とりあえずSphinxプロジェクトを作成する。下記のコマンドを入力して質問に答えていればすぐにできる。取り急ぎ入力するところは、Project nameとAuthor nameとProject versionだけ入力すればよい。あとはEnter連打。あとで気になったらconf.pyを編集すればよい。

$ sphinx-quickstart

これであとはファイルをどんどん更新するだけ。

bitbucketにpush

ひととおり編集を終えたらあとはpushするだけ。

$ hg ci -m 'hoge'
$ hg push

以上が終わったらあとは編集とpushを繰り返すだけです。

参考

簡単な操作については前に書いた。

Sphinxについてはしぶかわ先生が素敵なエントリを書いてくださった。