-
Notifications
You must be signed in to change notification settings - Fork 735
Description
Is your feature request related to a problem?
While reviewing #4728, there were Misc 0 / docs workflow failures which were correctly detecting formatting issues. I think these are always run with Python 3.11. However, some of us had issues reproducing the same errors on our local environments with tox -e doc
.
For example, the workflow gave this failure:
sphinx.errors.SphinxWarning: /home/runner/work/opentelemetry-python/opentelemetry-python/docs/examples/metrics/prometheus-grafana/README.rst:63:'any' reference target not found: MyAppPrefix_my_counter_total
But on local with Python 3.13 virtual environments, we'd get other unrelated failures first:
/Users/tammy.baylis/Dev/dupes3/opentelemetry-python/opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/__init__.py:docstring of opentelemetry.sdk._logs._internal.LogRecord:1:more than one target found for cross-reference 'Context': opentelemetry.context.Context, opentelemetry.context.context.Context
Describe the solution you'd like
I'm not sure! Here are some ideas:
(A) Update Development info to mention that CI/CD for several jobs are run in Python 3.11, so choose your environment with that in mind.
(B) Change basepython for docs
to Python 3.11 to match but duplicate CI/CD.
(C) Upgrade template to newest Python 3.13.
(D) If we did (C), we'd also have to update several existing docstring that are reporting issues with opentelemetry.context.context.Context
like above. Or, if such errors are temporary as Logging API becomes stable, maybe we update docs/conf.py with several new nitpick_ignore
entries temporarily.
Describe alternatives you've considered
No response
Additional Context
No response
Would you like to implement a fix?
None
Tip
React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1
or me too
, to help us triage it. Learn more here.