erlang - 如何在 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应用程序创建文档索引，但我对此表示怀疑。