Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Alternative to the erlang documentation
branch: master

Merge pull request #14 from johannesh/patch-1

Typo and `rebar get-deps` missing from the README
latest commit 6799cd040e
Dale  Harvey authored
Failed to load latest commit information.
src Added includes to type spec generator
templates Lets use utf8 when we actually fix utf8, for now use latin1 since it …
.gitignore UTF-8 compatibility.
Makefile Let us not require an internet connection to compile
README.markdown Typo and `rebar get-deps` missing from the README
erldocs Added includes to type spec generator
rebar Begin to rebarize
rebar.config Switched to ErlyDTL templates



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


Erlang R13B04 or greater


    git clone git://
    cd erldocs
    ./rebar get-deps

or download and place it in your $PATH


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".


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

Something went wrong with that request. Please try again.