如何在Erlang中为一组应用程序生成文档？

Question

我的问题

如何为多个应用程序生成类似OTP的文档？

说明

我开发了一个遵循OTP结构的应用程序库，我正在使用rebar来编译代码。

我的目录结构示例如下所示：

lib/
   apps/
      application_1/
         include/
         src/
      application_2/
         include/
         src/
      ...
   rebar.config
   rebar

我的rebar.config文件如下所示：

{sub_dirs, ["apps/application_1",
            "apps/application_2",
            ...]}.

当我运行rebar doc时，文档会生成并存储在每个应用程序目录中的doc文件夹中，但我想生成一个将库文件夹理解为一个单元的文档。换句话说，我想自动创建索引页面，就像Erlang文档一样。

我尝试了解erl_docgen，但无济于事。有没有办法做到这一点？

Answer 1

对于OTP，您在http://erlang.org/doc找到的文档似乎是使用一堆HTML模板，脚本和Makefile生成的。参见：

https://github.com/erlang/otp/tree/maint/system/doc/top

您可能希望将其用作自己的文档热门页面的“灵感”。

我不确定 rebar 是否可以为Erlang版本中包含的所有Erlang应用程序创建文档索引，但我对此表示怀疑。

Answer 2

medoc（对于多个 -edoc），是我写的一个rebar3插件，它会将所有文档放到同一个顶级doc目录中。