medoc

Runs edoc on multiple apps and stitches the results together.

The regular edoc command does not build the proper table of contents. This plugin fixes that, by first running edoc normally, and then rebuilding the html table of contents in place.

To see what problem this solves, see https://github.com/erlang/rebar3/issues/1307 and http://stackoverflow.com/questions/39043889/rebar3-generate-edoc-for-multiple-apps

Use

Add the plugin to your rebar config:

{plugins, [
    { medoc, ".*", {git, "git@github.com:drozzy/medoc.git", {tag, "0.1.0"}}}
]}.

Then just call your plugin directly in an existing application:

$ rebar3 medoc

Now you should be able to serve browse to doc/index.html and see your complete documentation.

Notes

This plugins modifies your edoc options, by setting it to be:

{edoc_opts, [{dir, "doc"}]}.