Skip to content

Commit

Permalink
Merge pull request #359 from erszcz/build-erlang-elixir-api-docs
Browse files Browse the repository at this point in the history
Build Erlang and Elixir docs for opentelemetry_api
  • Loading branch information
Tristan Sloughter authored Feb 10, 2022
2 parents 600257a + 0f1c08c commit 2cf4fec
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
5 changes: 5 additions & 0 deletions apps/opentelemetry_api/docs.config
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{source_url, <<"https://github.com/open-telemetry/opentelemetry-erlang">>}.
{extras, [<<"apps/opentelemetry_api/README.md">>,
<<"apps/opentelemetry_api/LICENSE">>]}.
{main, <<"readme">>}.
{proglang, erlang}.
10 changes: 10 additions & 0 deletions apps/opentelemetry_api/rebar.config
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
{erl_opts, [debug_info]}.
{deps, []}.

{profiles,
[{docs, [{deps, [edown]},
{edoc_opts,
[
{doclet, edoc_doclet_chunks},
{layout, edoc_layout_chunks},
{preprocess, true},
{dir, "apps/opentelemetry_api/_build/dev/lib/opentelemetry_api/doc"},
{subpackages, true}]}]}]}.
9 changes: 9 additions & 0 deletions docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,12 @@ ex_doc "opentelemetry_exporter" $version "_build/default/lib/opentelemetry_expor
--source-ref v${version} \
--config apps/opentelemetry_exporter/docs.config $@ \
--output "apps/opentelemetry_exporter/doc"

pushd apps/opentelemetry_api
mix deps.get
mix compile
popd
ex_doc "opentelemetry_api" $version "apps/opentelemetry_api/_build/dev/lib/opentelemetry_api/ebin" \
--source-ref v${version} \
--config apps/opentelemetry_api/docs.config $@ \
--output "apps/opentelemetry_api/doc"

0 comments on commit 2cf4fec

Please sign in to comment.