首页 文章

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

提问于
浏览 次
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，但无济于事 . 有没有办法做到这一点？

erlang documentation-generation rebar

2 回答

  • 2

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

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

    您可能希望将其用作"inspiration"用于您自己的文档首页 .

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

    回复于
  • 0

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

    回复于

相关问题