Skip to content

Commit

Permalink
docs: add testing.* Bazel objects to Sphinx inventory and xref in d…
Browse files Browse the repository at this point in the history
…ocs (#2185)

Also sorts the names in the inventory.
  • Loading branch information
rickeylev authored Sep 5, 2024
1 parent 612baef commit 3fd5b83
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
2 changes: 1 addition & 1 deletion python/private/py_exec_tools_info.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ when constructing the action invocation for running the precompiler program
(typically `exec_interpreter`). See the `PyInterpreterProgramInfo` provider docs
for details on how to construct an invocation.
If `testing.ExecutionInfo` is provided, it will be used to set execution
If {obj}`testing.ExecutionInfo` is provided, it will be used to set execution
requirements. This can be used to control persistent worker settings.
The precompiler command line API is:
Expand Down
18 changes: 12 additions & 6 deletions sphinxdocs/inventories/bazel_inventory.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,17 @@
# Version: 7.3.0
# The remainder of this file is compressed using zlib
Action bzl:type 1 rules/lib/Action -
ExecutionInfo bzl:type 1 rules/lib/providers/ExecutionInfo -
File bzl:type 1 rules/lib/File -
Label bzl:type 1 rules/lib/Label -
RunEnvironmentInfo bzl:type 1 rules/lib/providers/RunEnvironmentInfo -
Target bzl:type 1 rules/lib/builtins/Target -
attr.bool bzl:type 1 rules/lib/toplevel/attr#bool -
attr.int bzl:type 1 rules/lib/toplevel/attr#int -
attr.label bzl:type 1 rules/lib/toplevel/attr#label -
attr.label_list bzl:type 1 rules/lib/toplevel/attr#label_list -
attr.string bzl:type 1 rules/lib/toplevel/attr#string -
attr.string_list bzl:type 1 rules/lib/toplevel/attr#string_list -
bool bzl:type 1 rules/lib/bool -
callable bzl:type 1 rules/lib/core/function -
config_common.FeatureFlagInfo bzl:type 1 rules/lib/toplevel/config_common#FeatureFlagInfo -
Expand Down Expand Up @@ -48,12 +56,6 @@ int bzl:type 1 rules/lib/int -
depset bzl:type 1 rules/lib/depset -
dict bzl:type 1 rules/lib/dict -
label bzl:type 1 concepts/labels -
attr.bool bzl:type 1 rules/lib/toplevel/attr#bool -
attr.int bzl:type 1 rules/lib/toplevel/attr#int -
attr.label bzl:type 1 rules/lib/toplevel/attr#label -
attr.label_list bzl:type 1 rules/lib/toplevel/attr#label_list -
attr.string bzl:type 1 rules/lib/toplevel/attr#string -
attr.string_list bzl:type 1 rules/lib/toplevel/attr#string_list -
list bzl:type 1 rules/lib/list -
native.existing_rule bzl:function 1 rules/lib/toplevel/native#existing_rule -
native.existing_rules bzl:function 1 rules/lib/toplevel/native#existing_rules -
Expand All @@ -75,6 +77,10 @@ runfiles.root_symlinks bzl:type 1 rules/lib/builtins/runfiles#root_symlinks -
runfiles.symlinks bzl:type 1 rules/lib/builtins/runfiles#symlinks -
str bzl:type 1 rules/lib/string -
struct bzl:type 1 rules/lib/builtins/struct -
testing bzl:obj 1 rules/lib/toplevel/testing -
testing.analysis_test bzl:rule 1 rules/lib/toplevel/testing#analysis_test -
testing.ExecutionInfo bzl:function 1 rules/lib/toplevel/testing#ExecutionInfo -
testing.TestEnvironment bzl:function 1 rules/lib/toplevel/testing#TestEnvironment -
toolchain_type bzl:type 1 ules/lib/builtins/toolchain_type.html -
Name bzl:type 1 concepts/labels#target-names -
CcInfo bzl:provider 1 rules/lib/providers/CcInfo -
Expand Down

0 comments on commit 3fd5b83

Please sign in to comment.