読者です 読者をやめる 読者になる 読者になる

Elixirのドキュメント生成方法

mix.ex の deps に ex_docearmark を追加する。バージョンは最新版で。

  defp deps do
    [{:ex_doc, ">= 0.0.0", only: :docs},
     {:earmark, ">= 0.0.0", only: :docs}]
  end

パッケージのダウンロードとコンパイル

$ mix deps.get
$ mix deps.compile

環境変数に docs を設定して、mix docs コマンドを実行する。

$ MIX_ENV=docs mix docs

出来上がり。

ドキュメントを hex に上げる。

$ MIX_ENV=docs mix hex.docs