opentelemetry-python Test our docs

Describe your environment

OS: (e.g, Ubuntu) Python version: (e.g., Python 3.8.10) SDK version: (e.g., 1.25.0) API version: (e.g., 1.25.0)

What happened?

Nothing

Steps to Reproduce

We should add tests for our docs. Just testing that we can run the example in CI will do.

Expected Result

Doc tests running in CI

Actual Result

No tests running in CI

Additional context

No response

Would you like to implement a fix?

None

Jun 27 '24 17:06 ocelotl

Hi, I would like to try this one. But I didn't have a chance do documentation testing before. Is there any specific guidance or constraints I should be aware of before I start working on this? Thanks!

Jun 28 '24 23:06 zhihali

@Charlie-lizhihan I would start by looking at what we have right now here: https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/getting_started and include those tests as part of CI.

Jun 28 '24 23:06 emdneto

@emdneto Thank you so much!

Jul 01 '24 17:07 zhihali

Shameless plug, but I wrote oteltest for this purpose.

It lets you run example scripts or integration tests, with all configuration and logic co-located within each script.

Jul 01 '24 19:07 pmcollins

Hi, I'm interested in working on adding tests for the documentation. May I take this issue?

Jun 08 '25 23:06 sginji