Skip to content

sphinxdocs: make Any and object types no-ops to avoid missing xrefs #2905

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 18, 2025
Merged

sphinxdocs: make Any and object types no-ops to avoid missing xrefs #2905

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3fd91a
sphinxdocs: make Any and object types no-ops to avoid missing xrefs
rickeylev May 18, 2025
991907c
Merge branch 'main' of https://github.com/bazel-contrib/rules_python …
rickeylev May 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions sphinxdocs/src/sphinx_bzl/bzl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1766,6 +1766,11 @@ def _on_missing_reference(app, env: environment.BuildEnvironment, node, contnode
# There's no Bazel docs for None, so prevent missing xrefs warning
if node["reftarget"] == "None":
return contnode

# Any and object are just conventions from Python, but useful for
# indicating what something is in Starlark, so treat them specially.
if node["reftarget"] in ("Any", "object"):
Copy link
Collaborator

@dougthor42 dougthor42 May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

node["reftarget"].lower() in ("any", "object"):? I'm not sure if any is different from Any.

Copy link
Collaborator Author

@rickeylev rickeylev May 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In python land, it's case sensitive. This is all informal, so we can kind of make it up. And for doc purposes, either might be convenient. For now, I'm just gonna match Python.

return contnode
return None


Expand Down