Skip to content

Remove outdated Sphinx documentation target #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
castler merged 1 commit into from
May 4, 2026
+1 −60
Merged

Remove outdated Sphinx documentation target #376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 1 addition & 60 deletions docs/sphinx/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

load("@rules_python//python:defs.bzl", "py_binary")
load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
load("@rules_python//sphinxdocs:sphinx_docs_library.bzl", "sphinx_docs_library")
load(
"@score_tooling//bazel/rules/rules_score:rules_score.bzl",
Expand All @@ -21,44 +19,6 @@ load(
)
load("//docs/sphinx/utils:defs.bzl", "generate_api_rst")

# Create the sphinx-build binary with required dependencies
# This wrapper approach is used for older environments (e.g. Sphinx <=7.2.* and rules_python 1.2)
py_binary(
name = "sphinx-build-wrapper",
srcs = ["//docs/sphinx/utils:sphinx_build_wrapper"],
main = "sphinx_build_wrapper.py",
deps = [
"//third_party/breathe",
"//third_party/myst_parser",
"//third_party/pydata_sphinx_theme",
"//third_party/sphinx",
"//third_party/sphinx_rtd_theme",
],
)

# Native sphinx_build_binary for newer environments (e.g. Sphinx 9.*, rules_python 1.5)
sphinx_build_binary(
name = "sphinx-build-native",
deps = [
"//third_party/breathe",
"//third_party/myst_parser",
"//third_party/pydata_sphinx_theme",
"//third_party/sphinx",
"//third_party/sphinx_rtd_theme",
],
)

# Alias to select appropriate sphinx-build implementation based on feature flag
# Default: uses wrapper approach for compatibility with older environment
# Use --//path/to/sphinx/utils:use_native_sphinx_build for native binary
alias(
name = "sphinx-build",
actual = select({
"//docs/sphinx/utils:use_native": ":sphinx-build-native",
"//docs/sphinx/utils:use_wrapper": ":sphinx-build-wrapper",
}),
)

# Capture the Doxygen XML output for Breathe
sphinx_docs_library(
name = "doxygen_xml",
Expand All @@ -79,33 +39,14 @@ generate_api_rst(
project_name = "mw::com",
)

# Build Sphinx documentation
sphinx_docs(
name = "docs",
srcs = [
"how_to_document.rst",
"index.rst",
"introduction.rst",
"message_passing.rst",
":generate_api_rst",
":static_assets",
],
config = "conf.py",
formats = ["html"],
sphinx = ":sphinx-build",
deps = [
":doxygen_xml",
"//score/mw/com:readme_md",
],
)

filter_execpath(
name = "breathe_doxygen_xml",
filter_pattern = "doxygen_build/xml",
flag = "-Dbreathe_projects.doxygen_build",
target = "//docs/sphinx:doxygen_xml",
)

# Build Sphinx documentation
sphinx_module(
name = "sphinx_doc",
srcs =
Expand Down