Alternative to the erlang documentation
Erlang HTML Makefile
Latest commit 9a82b0b Jul 8, 2016 @daleharvey committed on GitHub Merge pull request #25 from fenollp/patch-1
Update README.markdown
Failed to load latest commit information.
priv
src
templates
.gitignore
Makefile
README.markdown
erldocs
rebar
rebar.config

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