Skip to content

Commit 21640ab

Browse files
authored
Offer :docs_combo (#441)
Deprecate :docs_combo_experimental
1 parent 0fdee30 commit 21640ab

3 files changed

Lines changed: 10 additions & 4 deletions

File tree

docs.bzl

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,8 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
192192
)
193193

194194
py_binary(
195-
name = "docs_combo_experimental",
196-
tags = ["cli_help=Build full documentation with all dependencies:\nbazel run //:docs_combo_experimental"],
195+
name = "docs_combo",
196+
tags = ["cli_help=Build full documentation with all dependencies:\nbazel run //:docs_combo"],
197197
srcs = ["@score_docs_as_code//src:incremental.py"],
198198
data = data_with_docs_sources + [":merged_sourcelinks"],
199199
deps = deps,
@@ -205,6 +205,12 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = []):
205205
},
206206
)
207207

208+
native.alias(
209+
name = "docs_combo_experimental",
210+
actual = ":docs_combo",
211+
deprecation = "Target '//:docs_combo_experimental' is deprecated. Use '//:docs_combo' instead.",
212+
)
213+
208214
py_binary(
209215
name = "docs_link_check",
210216
tags = ["cli_help=Verify Links inside Documentation:\nbazel run //:link_check\n (Note: this could take a long time)"],

docs/concepts/bidirectional_traceability.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Build with copies
4040

4141
.. code-block:: sh
4242
43-
bazel run //:docs_combo_experimental
43+
bazel run //:docs_combo
4444
4545
The documentation build does not depend on the needs.json but on whole documentation source code.
4646

docs/reference/commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------- |
55
| `bazel run //:docs` | Builds documentation |
66
| `bazel run //:docs_check` | Verifies documentation correctness |
7-
| `bazel run //:docs_combo_experimental` | Builds combined documentation with all external dependencies included |
7+
| `bazel run //:docs_combo` | Builds combined documentation with all external dependencies included |
88
| `bazel run //:live_preview` | Creates a live_preview of the documentation viewable in a local server |
99
| `bazel run //:live_preview_combo_experimental` | Creates a live_preview of the full documentation with all dependencies viewable in a local server |
1010
| `bazel run //:ide_support` | Sets up a Python venv for esbonio (Remember to restart VS Code!) |

0 commit comments

Comments
 (0)