rebar3为多个应用程序生成edoc

时间:2016-08-19 16:33:26

标签: erlang rebar3

如果我有这样的OTP布局:

echo base64_decode($image);

如何为 foo/ - apps/ - bar1/ - src/ - bar2 - src/ bar1 生成edoc?

如果我跑:

bar2

我得到的是rebar3 edoc .html中的单独bar1/doc个文件,它们之间没有任何链接正常工作(即导出类型未正确链接)。

谢谢。

2 个答案:

答案 0 :(得分:2)

现在Rebar3并不支持。

您可以看到in the source code edoc命令只是在每个应用程序上循环,而它们之间没有任何状态。

我不确定连接它们需要什么,但是在Rebar3存储库上打开一个问题来讨论它可能就是开始的方式。

答案 1 :(得分:1)

写了一个名为medoc的rebar3插件,它将确保edoc生成的文档正确链接并更新目录:

https://github.com/drozzy/medoc

运行方式:

rebar3 medoc

至于标准edoc,这似乎还不是一个功能。中间解决方案是在你的钢筋配置中使用它:

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

但是这不会正确更新目录(即你只会看到一个应用程序的toc)。