mix style documentation (#6)

* Hex doc

Documentation generation based on hex.pm publishing documentation recomendaton.
Provide using rebar3_ex_doc functionality. We have an option to generate mix style documetation of a Erlang library. To do so just run `rebar3 ex_doc --logo doc/img/logo.png  --output edoc` command and check a result.

* Tune rebar.config

* Update README.md

Add information related to documentation generation.

* Update .gitignore

Add logo image.

* Update .gitignore

Add logo image.

* Update .gitignore

Add ignoring edoc folder

* Tune GNUmakefile

Add an option to generate Exdoc to make file.
Tune README.md.

Author: rustkas

.gitignore

@@ -11,6 +11,10 @@ rel/example_project
 .rebar3
 _build/
 rebar3
+edoc
 doc/*
 !doc/style.css
 !doc/overview.edoc
+!doc/img
+!doc/img/*
+!doc/img/logo.png

CHANGELOG.md

@@ -0,0 +1,5 @@
+### v1.1.0
+
+- Move to GH Actions. by @mworrell in [#3](https://github.com/zotonic/dispatch_compiler/pull/3)
+- Property-based tests by @rustkas in [#5](https://github.com/zotonic/dispatch_compiler/pull/5)
+- Documentation improvements by @rustkas in [#4](https://github.com/zotonic/dispatch_compiler/pull/4)

GNUmakefile

@@ -36,7 +36,7 @@ xref: $(REBAR)
 
 test: $(REBAR)
 	$(REBAR) $(REBAR_OPTS) ct
-	$(REBAR) proper -n 1
+	$(REBAR) as test proper -n 1
 
 
 # Cleaning
@@ -64,4 +64,7 @@ docs: $(REBAR)
 	$(REBAR) edoc
 
 edoc_private: $(REBAR)	
-	$(REBAR) as edoc_private edoc
+	$(REBAR) as edoc_private edoc
+
+exdoc: $(REBAR)	
+	$(REBAR) ex_doc --logo doc/img/logo.png --output edoc

README.md

@@ -1,4 +1,5 @@
 ![Test](https://github.com/zotonic/dispatch_compiler/workflows/Test/badge.svg)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg?logo=apache&logoColor=red)](https://www.apache.org/licenses/LICENSE-2.0)
 
 # dispatch_compiler
 
@@ -70,3 +71,15 @@ If no dispatch rule could be matched, then `fail` is returned:
 
 Run `make test` to run the tests.
 
+## Documentation generation
+
+### Edoc
+
+#### Generate public API
+`rebar3 edoc`
+
+#### Generate private API
+`rebar3 as edoc_private edoc`
+
+### ExDoc
+`rebar3 ex_doc --logo doc/img/logo.png --output edoc`

doc/img/logo.png

@@ -2,4 +2,3 @@
 @title dispatch_compiler
 @doc Compiles dispatch rules to an Erlang module for quick matching.
 @copyright Apache 2.0
-

doc/overview.edoc

@@ -68,4 +68,4 @@ table[summary="navigation bar"] {
 
 code, p>tt, a>tt {
 	font-size: 1.2em;
-}
+}

doc/style.css

@@ -38,9 +38,28 @@
               no_return
           ]}
         ]},
-		
+		{plugins, [
+            rebar3_proper
+        ]},
 		{deps, [{proper,"1.4.0"}]}
     ]}
 ]}.
 
-{project_plugins, [rebar3_proper]}.
+{project_plugins, [rebar3_hex, rebar3_ex_doc]}.
+
+{hex, [
+    {doc, #{provider => ex_doc}}
+]}.
+
+{ex_doc, [
+    {extras, [
+          {"README.md", #{title => "Overview"}},
+		  {"CHANGELOG.md", #{title => "Changelog"}},
+          {"LICENSE", #{title => "License"}}
+    ]},
+    {main, "README.md"},
+    {source_url, "https://github.com/zotonic/dispatch_compiler"},
+    {assets, "assets"},
+    {api_reference, true}
+]}.
+