Fix docs build - #795
Closed
DylanRussell wants to merge 1 commit into
Closed
Fix docs build#795DylanRussell wants to merge 1 commit into
DylanRussell wants to merge 1 commit into
Conversation
Pull request dashboard statusClosed · refreshed 2026-09-25 15:13 UTC Status above doesn't look right?
|
DylanRussell
added a commit
to DylanRussell/opentelemetry-python-genai
that referenced
this pull request
Sep 25, 2026
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
No unresolved review issues remain, and documentation builds pass.
Review effort: Lite
Findings: None
What changed in this PR
Fixes Sphinx documentation builds by resolving recursive AnyValue annotations during type-hint evaluation.
Changes:
- Exposes
AnyValuethroughbuiltinsduring documentation generation. - Adds the workaround in
docs/conf.py.
| File | Description |
|---|---|
docs/conf.py |
Adds the documentation-time AnyValue forward-reference workaround. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
9 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
In
opentelemetry-api>= 1.45,AttributeValueis defined with recursive forward references to"AnyValue"(Sequence["AnyValue"] | Mapping[str, "AnyValue"]). Whensphinx-autodoc-typehintsevaluates type annotations in modules that importAttributeValuewithoutAnyValue, it fails to resolve"AnyValue"in the module namespace, raising aNameErrorand failing docs builds.This defines
AnyValueinbuiltinsduring doc generation withindocs/conf.py, allowing forward references to resolve across all documented modules without modifying library code.Type of change
How has this been tested?
docs build passes
Checklist