Add rebar3_ex_doc for generating docs

Author: cabol

Makefile

@@ -36,7 +36,7 @@ covertool: check_rebar
 	$(REBAR) as test covertool generate
 
 docs: check_rebar
-	$(REBAR) edoc
+	$(REBAR) ex_doc
 
 check: test covertool dialyzer xref docs
 	@echo "OK!"

README.md

@@ -1,4 +1,4 @@
-# Shards :sparkles:
+# Shards
 > ### ETS tables on steroids!
 > Sharding for ETS tables out-of-box.
 
@@ -30,7 +30,7 @@ and the **[online documentation](https://hexdocs.pm/shards/)**.
 [partitioning]: https://en.wikipedia.org/wiki/Partition_(database)
 [dht]: https://en.wikipedia.org/wiki/Distributed_hash_table
 [shards]: https://hexdocs.pm/shards/shards.html
-[getting_started]: guides/getting-started.md
+[getting_started]: https://hexdocs.pm/shards/getting-started.md
 
 ## Installation
 
@@ -59,18 +59,16 @@ end
 
 ## Important links
 
-  * [Documentation](https://hexdocs.pm/shards) - Hex Docs.
-
   * [Blog Post](http://cabol.github.io/posts/2016/04/14/sharding-support-for-ets.html) -
     Transparent and out-of-box sharding support for ETS tables in Erlang/Elixir.
 
   * Projects using **shards**:
     * [shards_dist](https://github.com/cabol/shards_dist) - Distributed version
       of `shards`. It was moved to a separate repo since `v1.0.0`.
-    * [ExShards](https://github.com/cabol/ex_shards) – Elixir wrapper for
-      `shards`; with extra and nicer functions.
     * [Nebulex](https://github.com/cabol/nebulex) – Distributed Caching
       framework for Elixir.
+    * [ExShards](https://github.com/cabol/ex_shards) – Elixir wrapper for
+      `shards`; with extra and nicer functions.
     * [KVX](https://github.com/cabol/kvx) – Simple Elixir in-memory Key/Value
       Store using `shards` (default adapter).
     * [Cacherl](https://github.com/ferigis/cacherl) Distributed Cache

rebar.config

@@ -44,7 +44,7 @@
 
 %% == Plugins ==
 
-{project_plugins, [rebar3_proper]}.
+{project_plugins, [rebar3_proper, rebar3_ex_doc]}.
 
 %% == Profiles ==
 
@@ -89,3 +89,20 @@
   deprecated_function_calls,
   deprecated_functions
 ]}.
+
+%% == Docs ==
+
+{hex, [
+  {doc, #{provider => ex_doc}}
+]}.
+
+{ex_doc, [
+  {source_url, <<"https://github.com/cabol/shards">>},
+  {extras, [
+    <<"guides/getting-started.md">>,
+    <<"README.md">>,
+    <<"CHANGELOG.md">>,
+    <<"LICENSE">>
+  ]},
+  {main, <<"readme">>}
+]}.

src/shards.app.src

@@ -9,9 +9,8 @@
   {env, []},
   {licenses, ["MIT"]},
   {build_tools, ["rebar3", "make"]},
+  {doc, "doc"},
   {links, [
-    {"GitHub", "https://github.com/cabol/shards"},
-    {"Getting Started", "https://github.com/cabol/shards/blob/master/guides/getting-started.md"},
-    {"Blog Post", "http://cabol.github.io/posts/2016/04/14/sharding-support-for-ets.html"}
+    {"GitHub", "https://github.com/cabol/shards"}
   ]}
 ]}.