sphinx でドキュメントを作成して云々なメモを残してみる

misc

後天性記憶不全な病を患っておりまして、備忘録な仕様書を作ることにしましたので、ついでというか一緒にメモも残しておくことにした次第です。

とりあえず

ディレクトリを掘っておきます。

$ mkdir tmp
$ cd tmp

で、sphinx-quickstart で適当な project name を付与してあとはデフォな返事で雛形ができます。ので、こいつらを git 管理にするために gitignore 作成して git init しておきます。

$ cat > .gitignore
*~
_build
$ git init
$ git add .
$ git commit -m 'initial commit'

で、リモートリポジトリを作って push (詳細ry
ちなみにリポジトリについては CI なナニを実装している場所で云々だったりするのでプロジェクトを作成して先に設定を仕込んでおきます。
ええと弄るのは

  • Source Code Management にてリポジトリを記述
  • Build Triggers は Poll SCM にして 5 分おきに、な '*/5 * * * *' な記述をナニ
  • Execute Shell なソレについては以下を追加
make clean html
rsync -aru --delete ./_build/html/* /var/www/hoge/.

hoge はてきとーに書き換えてます。
で、一発はリポジトリを poll するはず、って思ったらリポジトリに jenkins なアクセスの権限を付与してませんでした。5 分後どうなるかな。
rsync なオプション -aru を --aru にしててコンテンツがコピーされてなかった。ようやくスタート地点です。とは言え、ここから先は中身を編集して確認して push したら apache なドキュメントも更新されて、という繰り返しになりますので、エントリの記述自体はここで終了します。