Skip to content

Commit

Permalink
feat: Make Sphinx integration experimental publicly visible (bazelbui…
Browse files Browse the repository at this point in the history
…ld#1813)

With this commit the visibility settings are adjusted to use the Sphinx
Integration from rules_python also in other (dependent) projects.

Since the Sphinx integration is not yet stable, we denote in the
documentation that this is done under the experimental API support.
Meaning, breaking changes can occure at any point in time.

See the discussion in bazelbuild#1796
  • Loading branch information
castler authored Mar 18, 2024
1 parent b5d32cd commit e86252f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 4 additions & 4 deletions sphinxdocs/private/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ exports_files(
"sphinx_build.py",
"sphinx_server.py",
],
visibility = ["//:__subpackages__"],
visibility = ["//visibility:public"],
)

bzl_library(
Expand Down Expand Up @@ -70,22 +70,22 @@ py_binary(
name = "inventory_builder",
srcs = ["inventory_builder.py"],
# Only public because it's an implicit attribute
visibility = ["//:__subpackages__"],
visibility = ["//visibility:public"],
)

py_binary(
name = "proto_to_markdown",
srcs = ["proto_to_markdown.py"],
# Only public because it's an implicit attribute
visibility = ["//:__subpackages__"],
visibility = ["//visibility:public"],
deps = [":proto_to_markdown_lib"],
)

py_library(
name = "proto_to_markdown_lib",
srcs = ["proto_to_markdown.py"],
# Only public because it's an implicit attribute
visibility = ["//:__subpackages__"],
visibility = ["//visibility:public"],
deps = [
":stardoc_output_proto_py_pb2",
],
Expand Down
2 changes: 2 additions & 0 deletions sphinxdocs/sphinx.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ The general usage of the Sphinx rules requires two pieces:
Defining your own `sphinx-build` binary is necessary because Sphinx uses
a plugin model to support extensibility.
The Sphinx integration is still experimental.
"""

load(
Expand Down

0 comments on commit e86252f

Please sign in to comment.