erlang - rebar3 为多个应用程序生成 edoc

Question

如果我有这样的 OTP 布局：

foo/
  - apps/
    - bar1/
      - src/
    - bar2
      - src/

如何为和 bar1生成edoc bar2？

如果我运行：

rebar3 edoc

我得到的是 and 中的单独.html文件，bar1/doc并且bar2/doc它们之间的链接都不起作用（即导出类型未正确链接）。

谢谢你。

score 3 · Accepted Answer

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

运行为：

rebar3 medoc

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

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

但这不会正确更新目录（即您只会看到一个应用程序的目录）。

score 3 · Accepted Answer

Rebar3 目前不支持此功能。

您可以在源代码中看到该edoc命令只是在每个应用程序上循环，它们之间没有任何状态。

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

2 回答 2