erlang-domainを使ってみた。

Sphinx 1.0 からドメイン機能*1が追加されましたが、@shibukawaさんが、erlang-domain*2を公開されたので使ってみました。

erlang-domainを使うことで、きれいにマークアップされたErlangドキュメントを書くことができます。

1. まずは、インストールから

$ easy_install -ZU sphinx
$ easy_install -ZU sphinxcontrib-erlangdomain

2. クイックスタートでSphinxプロジェクトを作成します。
3. conf.py に、sphinxcontrib-erlangdomainの設定をする。

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinxcontrib.erlangdomain']

これで、erlangドメインを利用することができます。

本家にもコミットされたようで、別途インストールせずに利用することもできるようになるはずです。
http://bitbucket.org/birkenfeld/sphinx-contrib/changesets

*1:ドメイン機能 http://sphinx-users.jp/doc10/domains.html

*2:sphinxcontrib-erlangdomain http://pypi.python.org/pypi/sphinxcontrib-erlangdomain/0.1dev-20100827