Packages

rebar3_ex_doc

0.1.0
0.3.0 0.2.31 0.2.30 0.2.29 retired 0.2.28 0.2.27 0.2.26 0.2.25 0.2.24 0.2.23 0.2.22 0.2.21 0.2.20 0.2.19 0.2.18 0.2.17 0.2.16 0.2.15 0.2.14 0.2.13 0.2.12 0.2.11 0.2.10 retired 0.2.9 0.2.8 0.2.7 retired 0.2.6 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.0 retired

rebar3 plugin for generating docs with ex_doc

Retired package: Release invalid - rebar3_ex_doc was transferred to a new owner and this version is not related to the current version of rebar3_ex_doc
HexDocs

Current section

Files

Jump to
Readme
34 Versions
0 Dependencies
Dependants
Files
Activity
rebar3_ex_doc README.md
Raw

README.md 

rebar3_ex_doc

=====



A rebar plugin to build ex_doc documentation for the erlang edoc-annotated libraries



Build

-----



    $ rebar3 compile



Use

---



Add the plugin to your rebar config:



```erlang

    {plugins, [

        {rebar3_ex_doc, {git, "https://host/user/rebar3_ex_doc.git", {branch, "master"}}}

    ]}.



    {ex_doc, [

        {source_url, "https://github.com/<owner>/<repo>"}

    ]}.

```



Then just call your plugin directly in an existing application:



```shell

    $ rebar3 ex_doc

```