Skip to content
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

OTLP Exporters API documentation page is missing the API section #2786

Open
MoshiBin opened this issue Jun 28, 2022 · 3 comments
Open

OTLP Exporters API documentation page is missing the API section #2786

MoshiBin opened this issue Jun 28, 2022 · 3 comments
Labels
bug Something isn't working doc Documentation-related good first issue Good first issue help wanted

Comments

@MoshiBin
Copy link

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:
@MoshiBin MoshiBin added the bug Something isn't working label Jun 28, 2022
@ocelotl ocelotl added the doc Documentation-related label Jun 29, 2022
@RobsonSutton
Copy link

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
Copy link
Member

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
Copy link

@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 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working doc Documentation-related good first issue Good first issue help wanted
Projects
None yet
Development

No branches or pull requests

4 participants