rebar3 为多个应用程序生成 edoc答案

【问题标题】：rebar3 generate edoc for multiple appsrebar3 为多个应用程序生成 edoc
【发布时间】：2016-12-26 21:37:22
【问题描述】：

如果我有这样的 OTP 布局：

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

如何为bar1 和bar2 生成edoc？

如果我跑：

rebar3 edoc

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

谢谢。

【问题讨论】：

【解决方案1】：

Rebar3 目前不支持此功能。

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

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

【讨论】：

【解决方案2】：

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

运行方式：

rebar3 medoc

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

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

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

【讨论】：