Skip to content

Add exdoc to rebar.config #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mworrell merged 2 commits into from
Jul 1, 2026
Merged

Add exdoc to rebar.config #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5754fb
Add exdoc to rebar.config
mworrell Jul 1, 2026
c4bb8ac
Add doc make and CI target
mworrell Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This workflow checks the tests and dialyzer.
# This workflow checks the tests, dialyzer, and documentation build.

name: Test

Expand Down Expand Up @@ -34,3 +34,5 @@ jobs:
run: make xref
- name: Dialyzer
run: make dialyzer
- name: Docs
run: make doc
16 changes: 7 additions & 9 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 \
Expand Down
13 changes: 11 additions & 2 deletions rebar.config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -36,7 +46,6 @@
no_return
]}
]},

{erl_opts, [
debug_info
]}
Expand All @@ -45,4 +54,4 @@

{edoc_opts, [
{preprocess, true}, {stylesheet, "style.css"}
]}.
]}.
Loading