Alternative to the erlang documentation
Erlang HTML Makefile
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
priv Lookup type specs in seperate type specs xml files (fixes #12) Nov 27, 2011
src Added includes to type spec generator Nov 27, 2011
templates
.gitignore UTF-8 compatibility. Jul 8, 2011
Makefile Let us not require an internet connection to compile Nov 26, 2011
README.markdown
erldocs Added includes to type spec generator Nov 27, 2011
rebar
rebar.config Switched to ErlyDTL templates Nov 28, 2010

README.markdown

NOTE: the actively used & supported version of erldocs is at https://github.com/erldocs/erldocs

Erldocs

This is the code used to generate documentation for erlang projects in the format of erldocs.com

Dependencies

Erlang R13B04 or greater

Building

    git clone git://github.com/daleharvey/erldocs.git
    cd erldocs
    ./rebar get-deps
    make

or download https://github.com/daleharvey/erldocs/raw/master/erldocs and place it in your $PATH

Usage

Calling the erldocs script with no arguments will generate documentation for the application in the current working directory. The documentation will be output to "doc/erldocs".

./erldocs

Additional arguments can specify the location to source files to be documented

./erldocs path/to/erlang/otp/lib/* path/to/erlang/erts

You can specify the output directory with the -o flag

./erldocs -o path/to/output path/to/erlang/otp/lib/* path/to/erlang/erts