Skip to content

Commit

Permalink
doc: Remove manual tag from documentation binaries (RobotLocomotion#1…
Browse files Browse the repository at this point in the history
…4892)

There are no repository rules anymore that fail when --with-doc-only is
absent, so it's always safe to compile our documentation tooling.

Note that building the tooling does not actually generate the output by
default -- the tests are still tagged as manual.
  • Loading branch information
jwnimmer-tri authored Apr 12, 2021
1 parent 8205d93 commit f22df98
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 20 deletions.
8 changes: 4 additions & 4 deletions doc/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ load(
)
load(
":defs.bzl",
"DEFAULT_BINARY_TAGS",
"DEFAULT_TEST_TAGS",
"enumerate_filegroup",
)
Expand Down Expand Up @@ -112,14 +111,16 @@ drake_py_binary(
"//doc/pydrake:gen_sphinx",
"//doc/styleguide:build",
],
tags = DEFAULT_BINARY_TAGS,
deps = [
"@bazel_tools//tools/python/runfiles",
],
)

# This rule is used by our CI scripts as a single point of entry to ensure that
# all of our manually-tagged documentation binaries can be built successfully.
# all of our documentation binaries can be built successfully. The "manual" in
# its name is a bit of a misnomer (these all used to be tagged as manual, but
# we no longer need to exclude them from the build); all of these binaries are
# part of the default `bazel build //...`.
filegroup(
name = "manual_binaries",
srcs = [
Expand All @@ -130,7 +131,6 @@ filegroup(
"//doc/pydrake:serve_sphinx",
"//doc/styleguide:build",
],
tags = ["manual"],
)

# This rule is used by our CI scripts as a single point of entry to ensure that
Expand Down
8 changes: 0 additions & 8 deletions doc/defs.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@
# documentation targets (i.e., these should only be used for BUILD files
# within @drake//doc/...).

# Unless `setup/ubuntu/install_prereqs.sh --with-doc-only` has been run, most
# targets in //doc/... will fail to build, so by default we'll disable them.
#
# A developer will have to explicitly opt-in in order to build these.
DEFAULT_BINARY_TAGS = [
"manual",
]

# Unless `setup/ubuntu/install_prereqs.sh --with-doc-only` has been run, most
# tests in //doc/... will fail to pass, so by default we'll disable them.
#
Expand Down
2 changes: 0 additions & 2 deletions doc/doxygen_cxx/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ load(
)
load(
"//doc:defs.bzl",
"DEFAULT_BINARY_TAGS",
"DEFAULT_TEST_TAGS",
)
load("//tools/lint:lint.bzl", "add_lint_tests")
Expand Down Expand Up @@ -38,7 +37,6 @@ drake_py_binary(
"@bazel_tools//tools/python/runfiles",
"@doxygen",
],
tags = DEFAULT_BINARY_TAGS,
visibility = ["//doc:__pkg__"],
)

Expand Down
4 changes: 0 additions & 4 deletions doc/pydrake/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,13 @@ load(
)
load(
"//doc:defs.bzl",
"DEFAULT_BINARY_TAGS",
"DEFAULT_TEST_TAGS",
)
load("//bindings/pydrake:pydrake.bzl", "add_lint_tests_pydrake")

drake_py_library(
name = "sphinx_base",
srcs = ["sphinx_base.py"],
tags = DEFAULT_BINARY_TAGS,
deps = ["@rules_python//python/runfiles"],
)

Expand Down Expand Up @@ -45,7 +43,6 @@ drake_py_binary(
],
imports = ["."],
main = "build.py",
tags = DEFAULT_BINARY_TAGS,
test_rule_args = ["--out_dir=<test>"],
test_rule_size = "medium",
test_rule_tags = DEFAULT_TEST_TAGS,
Expand All @@ -61,7 +58,6 @@ drake_py_binary(
name = "serve_sphinx",
srcs = ["serve_sphinx.py"],
data = [":gen_sphinx"],
tags = DEFAULT_BINARY_TAGS,
visibility = ["//doc:__pkg__"],
deps = [":sphinx_base"],
)
Expand Down
2 changes: 0 additions & 2 deletions doc/styleguide/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ load(
)
load(
"//doc:defs.bzl",
"DEFAULT_BINARY_TAGS",
"DEFAULT_TEST_TAGS",
"enumerate_filegroup",
)
Expand Down Expand Up @@ -40,7 +39,6 @@ drake_py_binary(
":jekyll_input",
":jekyll_input.txt",
],
tags = DEFAULT_BINARY_TAGS,
test_rule_args = ["--out_dir=<test>"],
test_rule_size = "medium",
test_rule_tags = DEFAULT_TEST_TAGS,
Expand Down

0 comments on commit f22df98

Please sign in to comment.