Auto generated documentation for Elixir?

Questions / Help
1

Background

I have an app where I have all modudles and Behaviours doucmented with @moduledoc. Of these, some (the most important) also have functions with @doc.

Question

It would be a waste to not take advantage of this, so I wonder if there are any tools that can transform the @moduledoc and @doc documentation into hex documentation or something.

Where can I find such tools?

2
5 Likes
3

When you publish a package to hex, the publishing process will generate docs from your code and push them as well. You can run the task “mix docs” to generate your docs and then open the file doc/index.html in your browser to see the result.

2 Likes