Use rebar3_ex_doc

beam-telemetry · Feb 1, 2022 · ebe0f73 · ebe0f73
1 parent e071517
commit ebe0f73
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 24 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,7 +1,5 @@
 # Steps for publishing new version
 
 1. Update version in `src/telemetry.app.src`
-2. Update version in `docs.sh`
-3. Run `./docs.sh`
-4. Run `rebar3 as docs hex publish`
-5. Run `rebar3 as docs hex docs`
+2. Run `rebar3 hex publish`
+3. Run `rebar3 hex publish docs` (requires https://hexdocs.pm/rebar3_ex_doc)
diff --git a/docs.config b/docs.config
diff --git a/docs.sh b/docs.sh
diff --git a/rebar.config b/rebar.config
@@ -24,4 +24,12 @@
 {xref_checks,[undefined_function_calls, undefined_functions, locals_not_used,
               deprecated_function_calls, deprecated_functions]}.
 
+{hex, [
+    {doc, #{provider => ex_doc}}
+]}.
 
+{ex_doc, [
+    {source_url, <<"https://github.com/beam-telemetry/telemetry">>},
+    {extras, [<<"README.md">>, <<"CHANGELOG.md">>, <<"LICENSE">>, <<"NOTICE">>]},
+    {main, <<"readme">>}
+]}.
diff --git a/src/telemetry.erl b/src/telemetry.erl
@@ -394,7 +394,7 @@ assert_event_name(Term) ->
 merge_ctx(#{telemetry_span_context := _} = Metadata, _Ctx) -> Metadata;
 merge_ctx(Metadata, Ctx) -> Metadata#{telemetry_span_context => Ctx}.
 
-%% @hidden
+%% @private
 report_cb(#{handler_id := Id}) ->
     {"The function passed as a handler with ID ~w is a local function.\n"
      "This means that it is either an anonymous function or a capture of a function "