Documentation

Environment

Setup the environment just like it was done previously.

Set ERL_TOP the environment variable:

cd otp
export ERL_TOP=`pwd`

Also, set a destination path for the documentation:

export TESTROOT=<path>

The repository does not contain a generated configure file, so it must be generated like this:

./otp_build autoconf

before configure can be run. When the configure files has been generated, you can build in the usual way as described in the README file. Shortly:

./configure
make

Build documentation

To build the complete documentation for all applications. Build it from the top.

make release_docs

If only a specific application documentation needs to be built erl_docgen needs to be built also. Enter the erl_docgen directory and release the necessary files.

cd $ERL_TOP/lib/erl_docgen
make release_docs

Then enter the application directory and build its documentation.

cd $ERL_TOP/lib/<application>
make release_docs

This will generate man-pages, html-pages and a pdf-file for the application.