From cb8f91617d4d8a726e8a3ce4ca0370d42032c8dd Mon Sep 17 00:00:00 2001 From: Richard Levasseur Date: Tue, 1 Apr 2025 15:59:30 -0700 Subject: [PATCH] docs: fix various xrefs --- CHANGELOG.md | 2 +- docs/api/rules_python/python/config_settings/index.md | 2 +- docs/toolchains.md | 4 ++-- python/private/py_executable.bzl | 2 +- sphinxdocs/inventories/bazel_inventory.txt | 8 ++++++++ 5 files changed, 13 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ac41e81f6b..d87855899f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -68,7 +68,7 @@ Unreleased changes template. using `experimental_index_url`. * (toolchains) Remove all but `3.8.20` versions of the Python `3.8` interpreter who has reached EOL. If users still need other versions of the `3.8` interpreter, please supply - the URLs manually {bzl:ob}`python.toolchain` or {bzl:obj}`python_register_toolchains` calls. + the URLs manually {bzl:obj}`python.toolchain` or {bzl:obj}`python_register_toolchains` calls. [20250317]: https://github.com/astral-sh/python-build-standalone/releases/tag/20250317 diff --git a/docs/api/rules_python/python/config_settings/index.md b/docs/api/rules_python/python/config_settings/index.md index 79c7d0c109..95d60d6249 100644 --- a/docs/api/rules_python/python/config_settings/index.md +++ b/docs/api/rules_python/python/config_settings/index.md @@ -46,7 +46,7 @@ of builtin, known versions. If you need to match a version that isn't present, then you have two options: 1. Manually define a `config_setting` and have it match {obj}`--python_version` - or {ob}`python_version_major_minor`. This works best when you don't control the + or {obj}`python_version_major_minor`. This works best when you don't control the root module, or don't want to rely on the MODULE.bazel configuration. Such a config settings would look like: ``` diff --git a/docs/toolchains.md b/docs/toolchains.md index 0e4f5c2321..73a8a48121 100644 --- a/docs/toolchains.md +++ b/docs/toolchains.md @@ -265,7 +265,7 @@ use_repo(python, "python_3_10", "python_3_10_host") ``` Note, the user has to import the `*_host` repository to use the python interpreter in the -{bzl:obj}`pip_parse` and {bzl:obj}`whl_library` repository rules and once that is done +{bzl:obj}`pip_parse` and `whl_library` repository rules and once that is done users should be able to ensure the setting of the default toolchain even during the transition period when some of the code is still defined in `WORKSPACE`. @@ -364,7 +364,7 @@ toolchains a "toolchain suite". One of the underlying design goals of the toolchains is to support complex and bespoke environments. Such environments may use an arbitrary combination of -{obj}`RBE`, cross-platform building, multiple Python versions, +{bzl:obj}`RBE`, cross-platform building, multiple Python versions, building Python from source, embeding Python (as opposed to building separate interpreters), using prebuilt binaries, or using binaries built from source. To that end, many of the attributes they accept, and fields they provide, are diff --git a/python/private/py_executable.bzl b/python/private/py_executable.bzl index fed46ab223..21bd7bd85e 100644 --- a/python/private/py_executable.bzl +++ b/python/private/py_executable.bzl @@ -92,7 +92,7 @@ Only supported for {obj}`--bootstrap_impl=script`. Ignored otherwise. ::: :::{seealso} -The {obj}`RULES_PYTHON_ADDITIONAL_INTERPRETER_ARGS` environment variable +The {any}`RULES_PYTHON_ADDITIONAL_INTERPRETER_ARGS` environment variable ::: :::{versionadded} 1.3.0 diff --git a/sphinxdocs/inventories/bazel_inventory.txt b/sphinxdocs/inventories/bazel_inventory.txt index dc11f02b5b..458126a849 100644 --- a/sphinxdocs/inventories/bazel_inventory.txt +++ b/sphinxdocs/inventories/bazel_inventory.txt @@ -28,6 +28,14 @@ attr.string_list bzl:type 1 rules/lib/toplevel/attr#string_list - attr.string_list_dict bzl:type 1 rules/lib/toplevel/attr#string_list_dict - bool bzl:type 1 rules/lib/bool - callable bzl:type 1 rules/lib/core/function - +config bzl:obj 1 rules/lib/toplevel/config - +config.bool bzl:function 1 rules/lib/toplevel/config#bool - +config.exec bzl:function 1 rules/lib/toplevel/config#exec - +config.int bzl:function 1 rules/lib/toplevel/config#int - +config.none bzl:function 1 rules/lib/toplevel/config#none - +config.string bzl:function 1 rules/lib/toplevel/config#string - +config.string_list bzl:function 1 rules/lib/toplevel/config#string_list - +config.target bzl:function 1 rules/lib/toplevel/config#target - config_common.FeatureFlagInfo bzl:type 1 rules/lib/toplevel/config_common#FeatureFlagInfo - config_common.toolchain_type bzl:function 1 rules/lib/toplevel/config_common#toolchain_type - ctx.actions bzl:obj 1 rules/lib/builtins/ctx#actions -