Skip to content

Accept module root folder as docs source_dir #430

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

Open
paulquiring wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Accept module root folder as docs source_dir #430

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02c9ddc
Accept module root folder as docs source_dir
paulquiring Mar 3, 2026
e5d914e
simplify normalization
paulquiring Mar 3, 2026
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
48 changes: 28 additions & 20 deletions docs.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,14 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
if call_path != "":
fail("docs() must be called from the root package. Current package: " + call_path)


# Normalize "." and "./" to "" (workspace root)
if source_dir == "." or source_dir == "./":
source_dir = ""

# Prefix for glob patterns and label paths: "dir/" or "" at workspace root.
source_dir_prefix = (source_dir + "/") if source_dir else ""

module_deps = deps
deps = deps + _missing_requirements(deps)
deps = deps + [
Expand All @@ -154,18 +162,18 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
native.filegroup(
name = "docs_sources",
srcs = native.glob([
source_dir + "/**/*.png",
source_dir + "/**/*.svg",
source_dir + "/**/*.md",
source_dir + "/**/*.rst",
source_dir + "/**/*.html",
source_dir + "/**/*.css",
source_dir + "/**/*.puml",
source_dir + "/**/*.need",
source_dir + "/**/*.yaml",
source_dir + "/**/*.json",
source_dir + "/**/*.csv",
source_dir + "/**/*.inc",
source_dir_prefix + "**/*.png",
source_dir_prefix + "**/*.svg",
source_dir_prefix + "**/*.md",
source_dir_prefix + "**/*.rst",
source_dir_prefix + "**/*.html",
source_dir_prefix + "**/*.css",
source_dir_prefix + "**/*.puml",
source_dir_prefix + "**/*.need",
source_dir_prefix + "**/*.yaml",
source_dir_prefix + "**/*.json",
source_dir_prefix + "**/*.csv",
source_dir_prefix + "**/*.inc",
"more_docs/**/*.rst",
], allow_empty = True),
visibility = ["//visibility:public"],
Expand All @@ -184,7 +192,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
data = data + [":sourcelinks_json"],
deps = deps,
env = {
"SOURCE_DIRECTORY": source_dir,
"SOURCE_DIRECTORY": source_dir or ".",
"DATA": str(data),
"ACTION": "incremental",
"SCORE_SOURCELINKS": "$(location :sourcelinks_json)",
Expand All @@ -198,7 +206,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
data = data_with_docs_sources + [":merged_sourcelinks"],
deps = deps,
env = {
"SOURCE_DIRECTORY": source_dir,
"SOURCE_DIRECTORY": source_dir or ".",
"DATA": str(data_with_docs_sources),
"ACTION": "incremental",
"SCORE_SOURCELINKS": "$(location :merged_sourcelinks)",
Expand All @@ -212,7 +220,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
data = data,
deps = deps,
env = {
"SOURCE_DIRECTORY": source_dir,
"SOURCE_DIRECTORY": source_dir or ".",
"DATA": str(data),
"ACTION": "linkcheck",
},
Expand All @@ -225,7 +233,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
data = data + [":sourcelinks_json"],
deps = deps,
env = {
"SOURCE_DIRECTORY": source_dir,
"SOURCE_DIRECTORY": source_dir or ".",
"DATA": str(data),
"ACTION": "check",
"SCORE_SOURCELINKS": "$(location :sourcelinks_json)",
Expand All @@ -239,7 +247,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
data = data + [":sourcelinks_json"],
deps = deps,
env = {
"SOURCE_DIRECTORY": source_dir,
"SOURCE_DIRECTORY": source_dir or ".",
"DATA": str(data),
"ACTION": "live_preview",
"SCORE_SOURCELINKS": "$(location :sourcelinks_json)",
Expand All @@ -253,7 +261,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
data = data_with_docs_sources + [":merged_sourcelinks"],
deps = deps,
env = {
"SOURCE_DIRECTORY": source_dir,
"SOURCE_DIRECTORY": source_dir or ".",
"DATA": str(data_with_docs_sources),
"ACTION": "live_preview",
"SCORE_SOURCELINKS": "$(location :merged_sourcelinks)",
Expand All @@ -272,7 +280,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
sphinx_docs(
name = "needs_json",
srcs = [":docs_sources"],
config = ":" + source_dir + "/conf.py",
config = ":" + source_dir_prefix + "conf.py",
extra_opts = [
"-W",
"--keep-going",
Expand All @@ -291,7 +299,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
name = native.module_name() + "_module",
srcs = [":docs_sources"],
# config = ":" + source_dir + "/conf.py",
index = source_dir + "/index.rst",
index = source_dir_prefix + "index.rst",
sphinx = "@score_tooling//bazel/rules/rules_score:score_build",
deps = module_deps,
visibility = ["//visibility:public"],
Expand Down
Loading