docs: add stubs so Bazel docs link to a valid file (bazel-contrib#2309)

rickeylev · web-flow · commit 0e600586aea5 · 2024-10-17T00:39:35.000Z
The Bazel docs link to the implementation files, which were recently moved. To avoid users getting a 404, add stub files with some text to direct them somewhere useful. Work towards bazelbuild/bazel#24014
diff --git a/python/private/common/py_binary_rule_bazel.bzl b/python/private/common/py_binary_rule_bazel.bzl
@@ -0,0 +1,6 @@
+"""Stub file for Bazel docs to link to.
+
+The Bazel docs link to this file, but the implementation was moved.
+
+Please see: https://rules-python.readthedocs.io/en/latest/api/rules_python/python/defs.html#py_binary
+"""
diff --git a/python/private/common/py_library_rule_bazel.bzl b/python/private/common/py_library_rule_bazel.bzl
@@ -0,0 +1,6 @@
+"""Stub file for Bazel docs to link to.
+
+The Bazel docs link to this file, but the implementation was moved.
+
+Please see: https://rules-python.readthedocs.io/en/latest/api/rules_python/python/defs.html#py_library
+"""
diff --git a/python/private/common/py_runtime_rule.bzl b/python/private/common/py_runtime_rule.bzl
@@ -0,0 +1,6 @@
+"""Stub file for Bazel docs to link to.
+
+The Bazel docs link to this file, but the implementation was moved.
+
+Please see: https://rules-python.readthedocs.io/en/latest/api/rules_python/python/defs.html#py_runtime
+"""
diff --git a/python/private/common/py_test_rule_bazel.bzl b/python/private/common/py_test_rule_bazel.bzl
@@ -0,0 +1,6 @@
+"""Stub file for Bazel docs to link to.
+
+The Bazel docs link to this file, but the implementation was moved.
+
+Please see: https://rules-python.readthedocs.io/en/latest/api/rules_python/python/defs.html#py_test
+"""
