終わりと言いつつもう少し。
13.14 タスク: プロジェクトドキュメントの生成
ExDoc および earmark な依存関係を mix.exs に追加。
defp deps do
[
httpoison: "~> 0.8",
poison: "~> 1.5",
ex_doc: "~> 0.11",
earmark: ">= 0.0.0"
]
end
で、mix deps.get
なのかな。
$ mix deps.get
warning: variable "escript_config" does not exist and is being expanded to "escript_config()", please use parentheses to remove the ambiguity or change the variable name
mix.exs:7
Resolving Hex dependencies...
Dependency resolution completed:
Unchanged:
certifi 2.4.2
hackney 1.15.0
httpoison 0.13.0
idna 6.0.0
metrics 1.0.1
mimerl 1.0.2
parse_trans 3.3.0
poison 1.5.2
ssl_verify_fun 1.1.4
unicode_util_compat 0.4.1
New:
earmark 1.3.1
ex_doc 0.19.3
makeup 0.8.0
makeup_elixir 0.13.0
nimble_parsec 0.5.0
* Getting ex_doc (Hex package)
* Getting earmark (Hex package)
* Getting makeup_elixir (Hex package)
* Getting makeup (Hex package)
* Getting nimble_parsec (Hex package)
で、以下でドキュメント生成とのこと。
$ mix docs
warning: variable "escript_config" does not exist and is being expanded to "escript_config()", please use parentheses to remove the ambiguity or change the variable name
mix.exs:7
==> nimble_parsec
Compiling 4 files (.ex)
Generated nimble_parsec app
==> makeup
Compiling 45 files (.ex)
Generated makeup app
==> earmark
Compiling 1 file (.yrl)
Compiling 2 files (.xrl)
Compiling 3 files (.erl)
Compiling 25 files (.ex)
Generated earmark app
==> makeup_elixir
Compiling 4 files (.ex)
Generated makeup_elixir app
==> ex_doc
Compiling 18 files (.ex)
Generated ex_doc app
==> issues
Compiling 4 files (.ex)
Generated issues app
Docs successfully generated.
View them at "doc/index.html".
doc 配下に index.html できてます。これは便利ですね。
git
リモートリポジトリ作って反映の方向。