Add ex_doc for generating documentation

elixir-mongo · Aug 25, 2015 · 1d0102e · 1d0102e
1 parent dfc9984
commit 1d0102e
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@
 erl_crash.dump
 *.ez
 examples/simple/mix.lock
-db/
+/db
+/doc
diff --git a/mix.exs b/mix.exs
@@ -1,12 +1,17 @@
 defmodule Mongo.Ecto.Mixfile do
   use Mix.Project
 
+  @version "0.1.0"
+
   def project do
     [app: :mongodb_ecto,
-     version: "0.0.1",
+     version: @version,
      elixir: "~> 1.0",
      deps: deps,
-     test_coverage: [tool: ExCoveralls]]
+     test_coverage: [tool: ExCoveralls],
+     description: description,
+     package: package,
+     docs: docs]
   end
 
   def application do
@@ -17,9 +22,31 @@ defmodule Mongo.Ecto.Mixfile do
     [
       {:mongodb, "~> 0.1"},
       {:ecto, "~> 1.0"},
-      {:inch_ex, only: :docs},
       {:dialyze, "~> 0.2.0", only: :dev},
-      {:excoveralls, "~> 0.3.11", only: :test}
+      {:excoveralls, "~> 0.3.11", only: :test},
+      {:inch_ex, only: :docs},
+      {:earmark, "~> 0.1", only: :docs},
+      {:ex_doc, "~> 0.8", only: :docs}
     ]
   end
+
+  defp description do
+    """
+    MongoDB adapter for Ecto
+    """
+  end
+
+  defp package do
+    [contributors: ["Michał Muskała"],
+     licenses: ["Apache 2.0"],
+     links: %{"GitHub" => "https://github.com/michalmuskala/mongodb_ecto"},
+     files: ~w(mix.exs README.md lib)]
+  end
+
+  defp docs do
+    [readme: "README.md",
+     source_url: "https://github.com/michalmuskala/mongodb_ecto",
+     source_ref: "v#{@version}",
+     main: "README"]
+  end
 end
diff --git a/mix.lock b/mix.lock
@@ -1,7 +1,9 @@
 %{"connection": {:hex, :connection, "1.0.0-rc.1"},
   "decimal": {:hex, :decimal, "1.1.0"},
   "dialyze": {:hex, :dialyze, "0.2.0"},
+  "earmark": {:hex, :earmark, "0.1.17"},
   "ecto": {:hex, :ecto, "1.0.0"},
+  "ex_doc": {:hex, :ex_doc, "0.8.4"},
   "excoveralls": {:hex, :excoveralls, "0.3.11"},
   "exjsx": {:hex, :exjsx, "3.2.0"},
   "hackney": {:hex, :hackney, "1.3.1"},
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,4 +3,5 @@ @@
     erl_crash.dump
     *.ez
     examples/simple/mix.lock
-    db/
+    /db
+    /doc