switch to central docs-as-code tooling (#1052)

Author: MaximilianSoerenPollak

.github/workflows/test.yml

@@ -12,7 +12,6 @@
 # *******************************************************************************
 
 load("@score_cr_checker//:cr_checker.bzl", "copyright_checker")
-load("@score_dash_license_checker//:dash.bzl", "dash_license_checker")
 load("@score_starpls_lsp//:starpls.bzl", "setup_starpls")
 
 test_suite(
@@ -44,12 +43,6 @@ exports_files([
     "BUILD",
 ])
 
-dash_license_checker(
-    src = "//docs:requirements_lock",
-    file_type = "requirements",
-    visibility = ["//visibility:public"],
-)
-
 setup_starpls(
     name = "starpls_server",
     visibility = ["//visibility:public"],

BUILD

@@ -34,19 +34,6 @@ python.toolchain(
 )
 use_repo(python)
 
-###############################################################################
-#
-# docs dependencies (Sphinx)
-#
-###############################################################################
-pip = use_extension("@rules_python//python/extensions:pip.bzl", "pip")
-pip.parse(
-    hub_name = "pip_sphinx",
-    python_version = PYTHON_VERSION,
-    requirements_lock = "//docs:_tooling/requirements_lock.txt",
-)
-use_repo(pip, "pip_sphinx")
-
 # Additional Python rules provided by aspect, e.g. an improved version of
 # `py_binary`. But more importantly, it provides `py_venv`.
 bazel_dep(name = "aspect_rules_py", version = "1.0.0")
@@ -80,26 +67,13 @@ bazel_dep(name = "aspect_rules_lint", version = "1.0.3")
 ###############################################################################
 bazel_dep(name = "rules_java", version = "8.6.3")
 
-###############################################################################
-#
-# HTTP Jar rule deps
-#
-###############################################################################
-
-http_jar = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_jar")
-
-http_jar(
-    name = "plantuml",
-    sha256 = "6f38f70455d08438979451c2257cd5d58647c6460094bb829bc2a12878d47331",
-    url = "https://github.com/plantuml/plantuml/releases/download/v1.2025.0/plantuml-1.2025.0.jar",
-)
-
 ###############################################################################
 #
 # Misc. dependency
 #
 ###############################################################################
-bazel_dep(name = "score_dash_license_checker", version = "0.1.1")
+
+bazel_dep(name = "score_python_basics", version = "0.3.0")
 
 ###############################################################################
 #
@@ -114,3 +88,6 @@ bazel_dep(name = "score_cr_checker", version = "0.2.2")
 #
 ###############################################################################
 bazel_dep(name = "score_starpls_lsp", version = "0.1.0")
+# Checker rule for CopyRight checks/fixs
+
+bazel_dep(name = "score_docs_as_code", version = "0.1.0")

MODULE.bazel

@@ -11,78 +11,32 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 
-load("@aspect_rules_py//py:defs.bzl", "py_binary", "py_library", "py_venv")
-load("@pip_sphinx//:requirements.bzl", "all_requirements", "requirement")
 load("@rules_pkg//pkg:mappings.bzl", "pkg_files")
 load("@rules_pkg//pkg:tar.bzl", "pkg_tar")
-load("@rules_python//python:pip.bzl", "compile_pip_requirements")
-load("@rules_python//sphinxdocs:sphinx.bzl", "sphinx_build_binary", "sphinx_docs")
-load("//docs:_tooling/docs.bzl", "docs")
-load("//tools/testing/pytest:defs.bzl", "score_py_pytest")
-
-sphinx_requirements = all_requirements + [
-    "@rules_python//python/runfiles",
-    ":plantuml_for_python",
-]
+load("@score_docs_as_code//:docs.bzl", "docs")
 
 # Creates all documentation targets:
 # - `docs:incremental` for building docs incrementally at runtime
 # - `docs:live_preview` for live preview in the browser without an IDE
 # - `docs:ide_support` for creating python virtualenv for IDE support
 # - `docs:docs` for building documentation at build-time
-docs(source_files_to_scan_for_needs_links = [
-    # Note: you can add filegroups, globs, or entire targets here.
-    ":score_metamodel_files",
-    ":score_source_code_linker",
-])
-
-sphinx_build_binary(
-    name = "sphinx_build",
-    deps = sphinx_requirements,
-)
 
-# These are only exported because they're passed as files to the //docs.bzl
-# macros, and thus must be visible to other packages. They should only be
-# referenced by the //docs.bzl macros.
-exports_files(
-    glob(
-        [
-            "_tooling/**/*.py",
-        ],
-    ) + ["_tooling/requirements_lock.txt"],
-    visibility = ["//visibility:public"],
-)
-
-# In order to update the requirements, change the `requirements.txt` file and run:
-# `bazel run //docs:requirements`.
-# This will update the `requirements_lock.txt` file.
-# To upgrade all dependencies to their latest versions, run:
-# `bazel run //docs:requirements -- --upgrade`.
-compile_pip_requirements(
-    name = "requirements",
-    src = "_tooling/requirements.txt",
-    requirements_txt = "_tooling/requirements_lock.txt",
-    tags = [
-        "manual",
+docs(
+    conf_dir = "docs",
+    docs_targets = [
+        {
+            "suffix": "",  # local without external needs
+        },
     ],
-)
-
-# Enables source_code_linker to parse all file types, not just .py
-filegroup(
-    name = "score_metamodel_files",
-    srcs = glob(
-        ["_tooling/extensions/score_metamodel/**"],
-        exclude = ["**/__pycache__/**"],
-    ),
-    visibility = ["//visibility:public"],
+    source_dir = "docs",
+    source_files_to_scan_for_needs_links = [],
 )
 
 # Used inside //docs.bzl to enable access to the assets (css files etc.)
 filegroup(
-    name = "docs_assets",
+    name = "assets",
     srcs = glob([
         "_assets/**",
-        "_tooling/assets/**",
     ]),
     visibility = ["//visibility:public"],
 )
@@ -103,115 +57,3 @@ pkg_tar(
     name = "github-pages",
     srcs = [":html_files"],
 )
-
-java_binary(
-    name = "plantuml",
-    jvm_flags = ["-Djava.awt.headless=true"],
-    main_class = "net.sourceforge.plantuml.Run",
-    runtime_deps = [
-        "@plantuml//jar",
-    ],
-)
-
-# This makes it possible for py_venv to depend on plantuml.
-# Note: py_venv can only depend on py_library.
-# TODO: This can be removed with the next
-# upgrade of `aspect_rules_py` since the py_venv rule now supports a data field
-py_library(
-    name = "plantuml_for_python",
-    srcs = ["_tooling/dummy.py"],
-    data = [
-        ":plantuml",
-    ],
-)
-
-filegroup(
-    name = "test_rst_files",
-    srcs = glob([
-        "_tooling/extensions/score_metamodel/tests/rst/**/*.rst",
-        "_tooling/extensions/**/*.py",
-        "conf.py",
-    ]),
-    visibility = ["//visibility:public"],
-)
-
-# Dedicated metamodel target only for pytest.
-# It's required to define the imports for bazel pytest, so that python/pytest can
-# import "from score_metamodel" without issues.
-py_library(
-    name = "score_metamodel",
-    srcs = glob(["_tooling/extensions/score_metamodel/**/*.py"]),
-    imports = ["_tooling/extensions"],
-    visibility = ["//visibility:public"],
-)
-
-score_py_pytest(
-    name = "score_metamodel_test",
-    size = "small",
-    srcs = glob(["_tooling/extensions/score_metamodel/tests/**/*.py"]),
-    data = [
-        ":test_rst_files",
-    ],
-    visibility = ["//visibility:public"],
-    deps = [
-        ":score_metamodel",
-    ],
-)
-
-# ───────────────────────── Source code linker ────────────────────────
-# For more information see documentation at _tooling/extensions/score_source_code_linker/README.md
-py_library(
-    name = "score_source_code_linker",
-    srcs = glob(
-        ["_tooling/extensions/score_source_code_linker/**/*.py"],
-        exclude = ["_tooling/extensions/score_source_code_linker/tests/*.py"],
-    ),
-    imports = ["_tooling/extensions"],
-    visibility = ["//visibility:public"],
-)
-
-score_py_pytest(
-    name = "score_source_code_linker_test",
-    size = "small",
-    srcs = glob(["_tooling/extensions/score_source_code_linker/tests/**/*.py"]),
-    deps = [
-        ":score_source_code_linker",
-    ],
-)
-
-# Needed to make the file parser executeable and findable for the source_code_linker aspect
-py_binary(
-    name = "parsed_source_files_for_source_code_linker",
-    srcs = ["_tooling/extensions/score_source_code_linker/parse_source_files.py"],
-    visibility = ["//visibility:public"],
-)
-
-# Running this executes the `collect_source_files.bzl` aspect.
-# Collects all source files from specified targets in 'deps', and makes them available for parsing for the source_code_linker
-
-# Needed for Dash tool to check python dependency licenses.
-filegroup(
-    name = "requirements_lock",
-    srcs = [
-        "_tooling/requirements_lock.txt",
-    ],
-    visibility = ["//visibility:public"],
-)
-
-# Dedicated metamodel target only for pytest.
-# It's required to define the imports for bazel pytest, so that python/pytest can
-# import "from header_service" without issues.
-py_library(
-    name = "header_service",
-    srcs = glob(["_tooling/extensions/score_header_service/**/*.py"]),
-    imports = ["_tooling/extensions"],
-    visibility = ["//visibility:public"],
-)
-
-score_py_pytest(
-    name = "header_service_test",
-    size = "small",
-    srcs = glob(["_tooling/extensions/score_header_service/test/**/*.py"]),
-    visibility = ["//visibility:public"],
-    deps = [":header_service"],
-)