【Sphinx】reSTファイル内のタイトルにSubversionのリビジョン番号を付与する。

１．はじめに（動機）

自分用に貯めてきたSphinxのタイトル末尾にバージョン番号を付けることにしました。
その時のメモを共有します。

ポイント

• Subversionのリビジョン番号は $Rev$ を埋め込むと、$Rev: 543 $ のようにリビジョン番号を展開する。
• この $Rev: 543 $ の 543 だけを使いたい。
• SubWCRev は、Cygwin端末内で作業が完結しないのでイヤ。

２．概要

慣れている人なら、ここを読めば後は自分で作れる。

２．１．見出しの書式と拡張子

見出しの書式は 見出し文字列 [x.y.543]

拡張子 .rstx

• 見出し文字列 [x.y.$Rev: 543 $]
• このファイルをSubversionで管理
• .rst_ はGVimのシンタックスハイライトの設定ができない。

拡張子 .rst

• 見出し文字列 [x.y.543]
• .rstx のリビジョン番号を処理して作成。

２．２．仕組み

1. 元の .rst ファイルを、svn mv で .rstx に変更
2. 変換用スクリプト make-rst の作成と、 Makefile への埋め込み
3. GVimの対応
   • .rstx をGVimに紐付ける。
   • _gvimrc を編集して、シンタックスハイライトを有効にする。
4. .rst を無視するように svn:ignore を設定する。

３．詳細

注意） これからの作業で失敗した時のために、全てのファイルをsvn commitする。

３．１．元の拡張を変更

$ find source -name \*.rst -exec svn mv {} {}x \;

※なんかやらかしてしまったら、 svn revert してやり直す。

３．２．変換の仕組み

スクリプト

# !/usr/bin/bash
# .rstx: before
# .rst: after

convert_file()
{
        if [ ${1} -nt ${2} ]
        then
                echo "generate: ${2}"
                sed -e 's/\$Rev: \([0-9][0-9]*\) \$/\1/' ${1} > ${2}
        fi
}

create_rst()
{
        for src in `find $1 -name \*.rstx`
        do
                convert_file $src ${src%.rstx}.rst
        done
}

delete_rst()
{
        find $1 -name \*.rst -exec rm -f {} \;
        return 0
}

main()
{
        if [ "$1" = "" -o "$2" = "" ]
        then
                echo "error: no args"; return 127
        fi

        if [ ! -d $2 ]
        then
                echo "not found: $2"; return 126
        fi

        if [ "$1" = "clean" ]
        then
                delete_rst $2
        else
                create_rst $2
        fi

        return 0
}

main $1 $2 $3
exit $?

Makefile（変更点のみ抜粋）

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
clear: Makefile
        @$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

%: Makefile
        make-rst $@ $(SOURCEDIR)
        @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

３．３．GVimの対応

次の一行を追記する

autocmd BufNewFile,BufRead *.rstx set filetype=rst

３．４．svn:ignore の設定

理由は変わらないがこんなエラーになった。

$ svn ci -m "svn proedit snv:ignore" mathematics
Sending        mathematics
svn: E155011: Commit failed (details follow):
svn: E155011: Directory '/home/USERNAME/sphinx/physics/source/mathematics' is out of date
svn: E160028: Directory '/sphinx/trunk/physics/source/mathematics' is out of date

別の場所で同じものをチェックアウトし、そこで同じことやったら上手くいった。
もしかしたら svn update を実行していれば解決していたのかも。

以上