Generate opentelemetry_exporter docs with ExDoc

open-telemetry · Aug 21, 2021 · 297c832 · 297c832
1 parent 0ee4926
commit 297c832
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/apps/opentelemetry_exporter/docs.config b/apps/opentelemetry_exporter/docs.config
@@ -0,0 +1,5 @@
+{source_url, <<"https://github.com/open-telemetry/opentelemetry-erlang">>}.
+{extras, [<<"apps/opentelemetry_exporter/README.md">>,
+<<"apps/opentelemetry_exporter/LICENSE">>]}.
+{main, <<"readme">>}.
+{proglang, erlang}.
diff --git a/apps/opentelemetry_exporter/rebar.config b/apps/opentelemetry_exporter/rebar.config
@@ -7,3 +7,13 @@
         {gpb_opts, [{module_name_prefix, "opentelemetry_exporter_"},
                     {module_name_suffix, "_pb"},
                     {i, "apps/opentelemetry_exporter/opentelemetry-proto/"}]}]}.
+
+{profiles,
+ [{docs, [{deps, [edown]},
+          {edoc_opts,
+           [
+            {doclet, edoc_doclet_chunks},
+            {layout, edoc_layout_chunks},
+            {preprocess, true},
+            {dir, "_build/default/lib/opentelemetry_exporter/doc"},
+            {subpackages, true}]}]}]}.
diff --git a/docs.sh b/docs.sh
@@ -16,3 +16,7 @@ ex_doc "opentelemetry" $version "_build/default/lib/opentelemetry/ebin" \
   --config docs.config $@ \
   --output "apps/opentelemetry/doc"
 
+ex_doc "opentelemetry_exporter" $version "_build/default/lib/opentelemetry_exporter/ebin" \
+  --source-ref v${version} \
+  --config apps/opentelemetry_exporter/docs.config $@ \
+  --output "apps/opentelemetry_exporter/doc"