From d5754fb743353b8c591efa3f164466c565b7a707 Mon Sep 17 00:00:00 2001 From: Marc Worrell Date: Wed, 1 Jul 2026 14:03:18 +0200 Subject: [PATCH 1/2] Add exdoc to rebar.config --- rebar.config | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/rebar.config b/rebar.config index a80f526..74fd5c6 100644 --- a/rebar.config +++ b/rebar.config @@ -4,6 +4,16 @@ {require_min_otp_vsn, "18"}. +{project_plugins, [rebar3_ex_doc]}. + +{hex, [{doc, ex_doc}]}. + +{ex_doc, [ + {source_url, <<"https://github.com/erlangpack/erlang_exif">>}, + {extras, [<<"README.md">>, <<"LICENSE">>]}, + {main, <<"readme">>} +]}. + {erl_opts, [ debug_info, fail_on_warning @@ -36,7 +46,6 @@ no_return ]} ]}, - {erl_opts, [ debug_info ]} @@ -45,4 +54,4 @@ {edoc_opts, [ {preprocess, true}, {stylesheet, "style.css"} -]}. \ No newline at end of file +]}. From c4bb8ac4097ae28dc6e538c7f1957f26ef7598cb Mon Sep 17 00:00:00 2001 From: Marc Worrell Date: Wed, 1 Jul 2026 14:48:33 +0200 Subject: [PATCH 2/2] Add doc make and CI target --- .github/workflows/test.yml | 4 +++- Makefile | 16 +++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 6555248..8d80ce8 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -# This workflow checks the tests and dialyzer. +# This workflow checks the tests, dialyzer, and documentation build. name: Test @@ -34,3 +34,5 @@ jobs: run: make xref - name: Dialyzer run: make dialyzer + - name: Docs + run: make doc diff --git a/Makefile b/Makefile index 69924ba..5c53a2c 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ REBAR := ./rebar3 REBAR_URL := https://s3.amazonaws.com/rebar3/rebar3 ERL ?= erl -.PHONY: all compile shell test clean xref dialyzer +.PHONY: all compile shell test clean clean_doc xref dialyzer doc doc_private all: compile @@ -14,26 +14,24 @@ shell: $(REBAR) test: $(REBAR) $(REBAR) as test ct --readable true -c - + clean: $(REBAR) clean_doc $(REBAR) clean clean_doc: - @rm -f doc/*.html - @rm -f doc/erlang.png - @rm -f doc/edoc-info + @rm -rf doc xref: $(REBAR) $(REBAR) as test xref dialyzer: $(REBAR) $(REBAR) as check dialyzer - -doc: $(REBAR) doc/overview.edoc - $(REBAR) edoc + +doc: $(REBAR) + $(REBAR) ex_doc doc_private: $(REBAR) - $(REBAR) as doc_private edoc + $(REBAR) as doc_private edoc ./rebar3: $(ERL) -noshell -s inets -s ssl \