Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Alternative to the erlang documentation

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 priv
Octocat-spinner-32 src
Octocat-spinner-32 templates
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Makefile
Octocat-spinner-32 README.markdown
Octocat-spinner-32 rebar
Octocat-spinner-32 rebar.config
README.markdown

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/dreverri/erldocs.git
    cd erldocs
    make

Usage

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

./erldocs

Calling erldocs with one argument will changes the output directory to the one specified in the argument.

./erldocs docs/alternate_location

Calling erldocs with multiple arguments changes both the destination of the generated documentation and the source of the documentation.

./erldocs path/to/erlang/otp/lib/edoc doc/edoc_docs

Source arguments can use wildcards.

./erldocs path/to/erlang/otp/lib/* doc/otp_docs

Something went wrong with that request. Please try again.