Provide basics to generate doc with ex_doc

salemove · Aug 14, 2024 · f31f0e3 · f31f0e3
1 parent 7c84bce
commit f31f0e3
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,4 @@ rebar.lock
 *.log
 *.iml
 .idea/*
+.DS_Store
diff --git a/Makefile b/Makefile
@@ -52,6 +52,10 @@ edoc: profile=edown
 edoc:
 	@$(rebar_cmd) edoc
 
+.PHONY: ex_doc
+ex_doc:
+	@$(rebar_cmd) ex_doc
+
 .PHONY: dialyze
 dialyze: compile
 	@$(rebar_cmd) dialyzer

diff --git a/rebar.config b/rebar.config
@@ -27,3 +27,21 @@
 {xref_checks, [undefined_function_calls, undefined_functions,
                locals_not_used, deprecated_function_calls,
                deprecated_functions]}.
+
+{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"}},
+          {"NOTICE", #{title => "Notice"}}
+    ]},
+    {main, "README.md"},
+    {source_url, "https://github.com/kafka4beam/kafka_protocol"},
+    {api_reference, true}
+]}.
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,3 +16,4 @@ rebar.lock @@
     *.log
     *.iml
     .idea/*
+    .DS_Store