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各アプリケーション ディレクトリ内のフォルダーに保存されますが、ライブラリ フォルダーを 1 つの単位として理解するドキュメントを生成したいと考えています。つまり、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 に答える