Skip to content

feat: migrate from edoc to ex_doc#171

Merged
puzza007 merged 1 commit into
masterfrom
feat/ex-doc
Mar 19, 2026
Merged

feat: migrate from edoc to ex_doc#171
puzza007 merged 1 commit into
masterfrom
feat/ex-doc

Conversation

@puzza007

Copy link
Copy Markdown
Owner

Summary

  • Replace edoc with ex_doc (via rebar3_ex_doc) for modern, searchable hex docs
  • Add OTP 27 -moduledoc and -doc attributes to all modules
  • Replace %% @private / %% @equiv comments with -doc false / -doc #{equiv => ...}
  • Hide internal modules (katipo_app, katipo_sup, katipo_metrics) from generated docs
  • Include README and LICENSE as extra pages

Test plan

  • rebar3 compile passes
  • rebar3 ex_doc generates docs successfully
  • CI passes

@codecov

codecov Bot commented Feb 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.78%. Comparing base (29e9642) to head (6529e77).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #171   +/-   ##
=======================================
  Coverage   72.78%   72.78%           
=======================================
  Files           6        6           
  Lines        1062     1062           
=======================================
  Hits          773      773           
  Misses        289      289           
Flag Coverage Δ
c 72.78% <ø> (ø)
erlang 72.78% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@puzza007 puzza007 merged commit 0756e6a into master Mar 19, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant