rebar3 为多个应用程序生成 edoc

Question

如果我有这样的 OTP 布局：

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

如何为 bar1 和 bar2 生成 edoc？

如果我运行:

rebar3 edoc

我得到的是 bar1/doc 和 bar2/doc 中的单独 .html 文件，并且它们之间的链接 none 有效（即导出类型未正确链接） .

谢谢。

Answer 1

Rebar3 目前不支持此功能。

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

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

Answer 2

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

https://github.com/drozzy/medoc

运行 为：

rebar3 medoc

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

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

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