OTLP Exporters API documentation page is missing the API section

[MoshiBin]

The API section in the OpenTelemetry OTLP Exporters documentation page is not being generated. According to otlp.rst, it should be generated:

.. automodule:: opentelemetry.exporter.otlp.proto.grpc
    :members:
    :undoc-members:
    :show-inheritance:

[RobsonSutton]

I think it is behaving as has been defined, it just looks like this hasn't been updated as this functionality was probably split into a few submodules? You can see the contents of what is currently displayed via the UI here (https://github.com/open-telemetry/opentelemetry-python/blob/b9a6358583c0676482a043279c01b252dc6c308e/exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/__init__.py), but there is no code content for it to build the API docs from, it looks as though this has been split into trace_exporter, metric_exporter and _log_exporter but without any documentation currently.

I have raised the above PR to show what I mean, but I am new to opentelemetry and only at a basic scripting level with python and associated tooling, as opposed to being a guru so going to have to figure out how to go about testing this to ensure it behaves as expected unless anyone has any recommendations / can point me in the right direction of course!

[srikanthccv]

If you run the tox command tox -e docs it should error if there is any issue with documentation. Otherwise, it will create a _build/html folder which contains the API documentation file. You should be able to browse the generated documentation by opening index.html and see if did what you expected it to do.

[RobsonSutton]

@srikanthccv - Thank you for the comment! I'll take a look at this later today and hopefully tidy everything up a bit more and have it appropriately tested 👍

[sid200727]

Hi!
I’d like to pick this up if it’s still relevant.
From the discussion, it looks like the API docs are not being generated because the OTLP exporters were split into submodules (trace / metric / log), and the Sphinx automodule configuration may no longer be pointing to the correct modules.

My plan is to:

• Reproduce the issue locally using tox -e docs
• Identify which exporter modules should be documented
• Update the relevant .rst files so the API section is generated correctly
• Verify the fix by checking the built HTML output

Please let me know if this approach sounds good or if there’s any guidance I should follow before starting. Thanks!

[alliasgher]

Opened #5124 for this.