Rebar3 plugin to generate docs for multi-app OTP releases.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
priv
src
.gitignore
LICENSE
README.md
icon.png
rebar.config
rebar.lock
rebar3

README.md

medoc

Icon

Runs edoc on multiple apps and stitches the results together.

If you have an OTP layout like this:

foo/

  • apps/
    • bar1/
      • src/
    • bar2
      • src/

you can generate the edoc documentation for all your apps with rebar3 medoc. The resulting html documention can be found under foo/doc:

foo/

  • doc/
    • index.html
    • bar1_app.html
    • bar2_app.html
    • ...

Description

The regular rebar3 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

Install

Add the plugin to your rebar config:

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

Alternatively use the hex.pm medoc package.

Usage

Call your plugin directly in an existing application:

$ rebar3 medoc

Now you should be able to see your complete documentation at doc/index.html.

Notes

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

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