3

我的问题

如何为多个应用程序生成类似 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，但无济于事。有没有办法做到这一点？

4

2 回答 2

2

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

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

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

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

于 2012-10-26T12:49:19.183 回答
1

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

于 2016-09-09T16:43:18.450 回答