Documentation improvements

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
 
     strategy:
       matrix:
-        otp_version: [21,22,23]
+        otp_version: [22,23,24]
         os: [ubuntu-latest]
 
     container:

.gitignore

@@ -10,4 +10,7 @@ rel/example_project
 .rebar
 .rebar3
 _build/
-rebar3
+rebar3
+doc/*
+!doc/style.css
+!doc/overview.edoc

GNUmakefile

@@ -55,3 +55,12 @@ clean: clean_logs $(REBAR)
 dist-clean: clean
 	$(REBAR) $(REBAR_OPTS) clean -a
 	rm -f ./rebar3
+
+##
+## Doc targets
+##
+docs: $(REBAR)
+	$(REBAR) edoc
+
+edoc_private: $(REBAR)	
+	$(REBAR) as edoc_private edoc

doc/overview.edoc

@@ -0,0 +1,5 @@
+@author Zotonic Team
+@title dispatch_compiler
+@doc Compiles dispatch rules to an Erlang module for quick matching.
+@copyright Apache 2.0
+

doc/style.css

@@ -0,0 +1,71 @@
+/* standard EDoc style sheet */
+body {
+	font-family: Verdana, Arial, Helvetica, sans-serif;
+      	margin-left: .25in;
+       	margin-right: .2in;
+       	margin-top: 0.2in;
+       	margin-bottom: 0.2in;
+       	color: #000000;
+       	background-color: #ffffff;
+}
+h1,h2 {
+ 	margin-left: -0.2in;
+}
+div.navbar {
+	background-color: #add8e6;
+	padding: 0.2em;
+}
+h2.indextitle {
+	padding: 0.4em;
+	background-color: #add8e6;
+}
+h3.function,h3.typedecl {
+	background-color: #add8e6;
+ 	padding-left: 1em;
+}
+div.spec {
+ 	margin-left: 2em;
+
+	background-color: #eeeeee;
+}
+a.module {
+	text-decoration:none
+}
+a.module:hover {
+	background-color: #eeeeee;
+}
+ul.definitions {
+	list-style-type: none;
+}
+ul.index {
+	list-style-type: none;
+	background-color: #eeeeee;
+}
+
+/*
+ * Minor style tweaks
+ */
+ul {
+	list-style-type: square;
+}
+table {
+	border-collapse: collapse;
+}
+td {
+	padding: 3px;
+	vertical-align: middle;
+}
+
+/*
+Tune styles
+*/
+
+table[summary="navigation bar"] {
+	background-image: url('http://zotonic.com/lib/images/logo.png');
+	background-repeat: no-repeat;
+	background-position: center;
+}
+
+code, p>tt, a>tt {
+	font-size: 1.2em;
+}

rebar.config

@@ -21,3 +21,23 @@
     {dispatch_compiler, match, 3},
     {dispatch_compiler, runtime_bind, 3}
 ]}.
+
+{edoc_opts, [
+    {preprocess, true}, {stylesheet, "style.css"}
+]}.
+
+{profiles, [
+	{edoc_private, [
+		{edoc_opts, [
+			{private, true}
+		]}
+	]},
+	{test, [
+	    {dialyzer, [
+          {warnings, [
+              no_return
+          ]}
+        ]}
+
+    ]}
+]}.