rebar3为多个应用程序生成edoc

Question

5

如果我有一个像这样的OTP布局：

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

如何同时为bar1和bar2生成edoc文档？

如果我执行以下命令：

rebar3 edoc

我得到的是在 `bar1/doc` 和 `bar2/doc` 中分别有独立的 `.html` 文件，但它们之间的链接都无法正常工作（即导出类型链接不正确）。

谢谢。

- Andriy Drozdyuk

2个回答

3

目前Rebar3不支持此功能。

您可以在源代码中看到，edoc命令只是循环遍历每个应用程序，没有保留它们之间的状态。

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

- Nathaniel Waisbrot

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Andriy Drozdyuk · Accepted Answer

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

运行方式:

rebar3 medoc

至于标准的edoc，目前似乎还没有这个功能。一个中间解决方案是在您的rebar配置中使用以下内容：

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

但是这种方法不能正确更新目录（也就是只能看到一个应用程序的目录）。