search

jelly-beam / rebar3_ex_doc

rebar3 plugin for generating docs with ex_doc
Apache License 2.0
43 stars 13 forks source link

Add dependencies to code path #14

Closed weiss closed 2 years ago

weiss commented 2 years ago

Add the ebin directories of dependencies to the code path using ex_doc's --paths option. Otherwise, if foo.erl references dep:type/0, this results in the following warning:

warning: documentation references type "dep:type/0" but it is undefined or private
  src/foo.erl:37: dep.type/0
starbelly commented 2 years ago

Makes sense to me 👍 I'll give this a go later on today.

weiss commented 2 years ago

Thanks! :+1: (And thank you for the plugin, I used a manual hack before, nice replacement!)

Anyway, I just force-pushed a change to cope with the case where no dependencies are used at all. I.e., to avoid adding a dangling --paths argument in that case.

starbelly commented 2 years ago

@weiss Tested this out, works like a charm 🚀

starbelly commented 2 years ago

rebar3_ex_doc 0.2.7 released ❤️💛💚💙💜