Documentation

(origin: erlang/otp/wiki/Documentation/bdc90a7, Translated at 2013-07-24 +09:00 JST)

環境の設定 (Setting up the Environment)

環境は Erlang/OTP をビルドする通常の方法で設定します. ERL_TOP 環境変数を設定します:

cd <your-otp-build-directory>
export ERL_TOP=`pwd`

ドキュメントの目的パスも設定します:

export TESTROOT=<path>

レポジトリには生成済みの configure ファイルは含まれていません. これを以下の手順で生成しておく必要があります

./otp_build autoconf

これで configure を実行できるようになります. configure ファイルが生成されれば README ファイルにかかれているように通常の手順でビルドすることができます. 大雑把には:

./configure
make

もし自分のローカルディレクトリに設置するためにビルドしているのであれば, configure コマンドを以下のように発行する必要があります:

./configure --prefix=<localdir>

全てのアプリケーションの完全なドキュメントビルドする場合は天辺でビルドします:

make release_docs

毒低のアプリケーションのドキュメントのみをビルドしたいだけであれば, まず erl_docgen をビルドする必要があります.
erl_docgen ディレクトリにはいり必要なファイルを生成します:

cd $ERL_TOP/lib/erl_docgen
make release_docs

それから特定のアプリケーションのディレクトリにはいり, そのドキュメントをビルドします:

cd $ERL_TOP/lib/<application>
make release_docs

これによってアプリケーションのドキュメントが3つの形式で生成されます: UNIX形式マニュアルページ, HTML, そして PDF で Erlang/OTP リファレンスマニュアルの該当の章.