Skip to content

sphinxdocs: make xrefs to bzl:obj in inventories work #2894

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
rickeylev merged 1 commit into from
May 17, 2025
Merged

sphinxdocs: make xrefs to bzl:obj in inventories work #2894

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 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 @@ -1463,6 +1463,8 @@ class _BzlDomain(domains.Domain):
# :obj:.
# NOTE: We also use these object types for categorizing things in the
# generated index page.
# NOTE: The object type keys control what object types are recognized
# in inventory files.
object_types = {
"arg": domains.ObjType("arg", "arg", "obj"), # macro/function arg
"aspect": domains.ObjType("aspect", "aspect", "obj"),
Expand All @@ -1486,6 +1488,8 @@ class _BzlDomain(domains.Domain):
# types are objects that have a constructor and methods/attrs
"type": domains.ObjType("type", "type", "obj"),
"typedef": domains.ObjType("typedef", "typedef", "type", "obj"),
# generic objs usually come from inventories
"obj": domains.ObjType("object", "obj")
}

# This controls:
Expand Down