Skip to content

Instantly share code, notes, and snippets.

@brweber2
Created April 27, 2016 12:16
Show Gist options
  • Save brweber2/9c888641bdb4892cf4c65683164ef527 to your computer and use it in GitHub Desktop.
Save brweber2/9c888641bdb4892cf4c65683164ef527 to your computer and use it in GitHub Desktop.

Question 1

  • Add module documentation to redpull and generate the html files

Question 2

  • Add function documentation to redpull and generate the updated html files
@doc """
Here is some documentation.
* It is just markdown.
* This is a list.
* Yeah lists!
"""
def main(_args) do
  IO.puts "Hello, World!"
end
  • add this to mix.exs
defp deps do
  [{:earmark, "~> 0.1", only: :dev},
  {:ex_doc, "~> 0.7", only: :dev}]
end
  • mix deps.get

  • mix docs

  • open doc/index.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment