Skip to content

Commit e5fa023

Browse files
authored
docs: fix a few xrefs (#2740)
Fixes a few xrefs in the docs that had typos or missing external bazel links.
1 parent 0196825 commit e5fa023

File tree

5 files changed

+13
-5
lines changed

5 files changed

+13
-5
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Unreleased changes template.
6868
using `experimental_index_url`.
6969
* (toolchains) Remove all but `3.8.20` versions of the Python `3.8` interpreter who has
7070
reached EOL. If users still need other versions of the `3.8` interpreter, please supply
71-
the URLs manually {bzl:ob}`python.toolchain` or {bzl:obj}`python_register_toolchains` calls.
71+
the URLs manually {bzl:obj}`python.toolchain` or {bzl:obj}`python_register_toolchains` calls.
7272
* (pypi) The PyPI extension will no longer write the lock file entries as the
7373
extension has been marked reproducible.
7474
Fixes [#2434](https://github.com/bazel-contrib/rules_python/issues/2434).

docs/api/rules_python/python/config_settings/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ of builtin, known versions.
4646

4747
If you need to match a version that isn't present, then you have two options:
4848
1. Manually define a `config_setting` and have it match {obj}`--python_version`
49-
or {ob}`python_version_major_minor`. This works best when you don't control the
49+
or {obj}`python_version_major_minor`. This works best when you don't control the
5050
root module, or don't want to rely on the MODULE.bazel configuration. Such
5151
a config settings would look like:
5252
```

docs/toolchains.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ use_repo(python, "python_3_10", "python_3_10_host")
265265
```
266266

267267
Note, the user has to import the `*_host` repository to use the python interpreter in the
268-
{bzl:obj}`pip_parse` and {bzl:obj}`whl_library` repository rules and once that is done
268+
{bzl:obj}`pip_parse` and `whl_library` repository rules and once that is done
269269
users should be able to ensure the setting of the default toolchain even during the
270270
transition period when some of the code is still defined in `WORKSPACE`.
271271

@@ -364,7 +364,7 @@ toolchains a "toolchain suite".
364364

365365
One of the underlying design goals of the toolchains is to support complex and
366366
bespoke environments. Such environments may use an arbitrary combination of
367-
{obj}`RBE`, cross-platform building, multiple Python versions,
367+
{bzl:obj}`RBE`, cross-platform building, multiple Python versions,
368368
building Python from source, embeding Python (as opposed to building separate
369369
interpreters), using prebuilt binaries, or using binaries built from source. To
370370
that end, many of the attributes they accept, and fields they provide, are

python/private/py_executable.bzl

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Only supported for {obj}`--bootstrap_impl=script`. Ignored otherwise.
9292
:::
9393
9494
:::{seealso}
95-
The {obj}`RULES_PYTHON_ADDITIONAL_INTERPRETER_ARGS` environment variable
95+
The {any}`RULES_PYTHON_ADDITIONAL_INTERPRETER_ARGS` environment variable
9696
:::
9797
9898
:::{versionadded} 1.3.0

sphinxdocs/inventories/bazel_inventory.txt

+8
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ attr.string_list bzl:type 1 rules/lib/toplevel/attr#string_list -
2828
attr.string_list_dict bzl:type 1 rules/lib/toplevel/attr#string_list_dict -
2929
bool bzl:type 1 rules/lib/bool -
3030
callable bzl:type 1 rules/lib/core/function -
31+
config bzl:obj 1 rules/lib/toplevel/config -
32+
config.bool bzl:function 1 rules/lib/toplevel/config#bool -
33+
config.exec bzl:function 1 rules/lib/toplevel/config#exec -
34+
config.int bzl:function 1 rules/lib/toplevel/config#int -
35+
config.none bzl:function 1 rules/lib/toplevel/config#none -
36+
config.string bzl:function 1 rules/lib/toplevel/config#string -
37+
config.string_list bzl:function 1 rules/lib/toplevel/config#string_list -
38+
config.target bzl:function 1 rules/lib/toplevel/config#target -
3139
config_common.FeatureFlagInfo bzl:type 1 rules/lib/toplevel/config_common#FeatureFlagInfo -
3240
config_common.toolchain_type bzl:function 1 rules/lib/toplevel/config_common#toolchain_type -
3341
ctx.actions bzl:obj 1 rules/lib/builtins/ctx#actions -

0 commit comments

Comments
 (0)