-
Notifications
You must be signed in to change notification settings - Fork 326
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.
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
Generating both Erlang and Elixir docs at once #1895
Comments
opentelemetry_api has docs for both languages: https://hexdocs.pm/opentelemetry_api/OpenTelemetry.Span.html So I believe it’s just a matter of configuration. |
It is also worth noting that this should work out of the box with Erlang/OTP 27 and the new docs. Previous Erlang versions require a rebar3 plugin, which makes it too much work for us to support out of the box (but it is possible as long as configuration is provided) |
@wojtekmach I’m aware, but the setup is pretty non-intuitive. I cannot, for the life of me, reproduce this consistently. It seems to be a combination of:
Not sure how this works given
Perfect.
Folks, I’m not arguing to add this to ExDoc now 🙃 It would be a great addition to document how to do this now, with the Rebar plugin and whatnot, given it's really not trivial IMO. I think that would be beneficial anyway, because OTP 27 is a couple months away and not everybody will be able to update and switch to the new Erlang doc format right away. Thoughts? |
OTP 27 is a month away (probably less). We would accept contributions to document this but it is unlikely we will invest effort given a better more integrated mechanism will be available within a month. I understand migrating to OTP 27 may be hard for applications but for most libraries it should be straight-forward. |
The OpenTelemetry projects often expose both an Erlang and an Elixir API. Right now, unless I’m missing something, it's pretty cumbersome to expose docs for both via ExDoc.
Let's take opentelemetry_telemetry as an example. It exposes just a single Elixir module (
OpentelemetryTelemetry
) and one Erlang module (otel_telemetry
). It has amix.exs
config file as well as arebar.config
file.You can see what I’m talking about because the generated docs on hexdocs.pm are only for the Elixir module: https://hexdocs.pm/opentelemetry_telemetry/OpentelemetryTelemetry.html
I wanted to open this issue to:
Thanks for the time!
The text was updated successfully, but these errors were encountered: