From f54b3fb34c388e96d33f194e2a861050479e72e5 Mon Sep 17 00:00:00 2001 From: Maximilian Pollak Date: Fri, 1 Aug 2025 10:03:51 +0200 Subject: [PATCH] Docs-as-Code 1.0.1 Upgrade This PR will enable Module Template to use DaC 1.0.1 - Upgrades the bazel version to 8.3 - Upggrades several dependencies - Changed command to build documentaiton in the workflows --- .bazelversion | 2 +- .github/workflows/docs.yml | 2 +- BUILD | 12 +++++------- MODULE.bazel | 10 +++++----- docs/BUILD | 18 ------------------ docs/conf.py | 2 ++ 6 files changed, 14 insertions(+), 32 deletions(-) delete mode 100644 docs/BUILD diff --git a/.bazelversion b/.bazelversion index b616717..2bf50aa 100644 --- a/.bazelversion +++ b/.bazelversion @@ -1 +1 @@ -7.4.0 \ No newline at end of file +8.3.0 diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 251b6c6..24bd399 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -39,5 +39,5 @@ jobs: with: # the bazel-target depends on your repo specific docs_targets configuration (e.g. "suffix") - bazel-target: "//docs:incremental -- --github_user=${{ github.repository_owner }} --github_repo=${{ github.event.repository.name }}" + bazel-target: "//:docs -- --github_user=${{ github.repository_owner }} --github_repo=${{ github.event.repository.name }}" retention-days: 3 diff --git a/BUILD b/BUILD index f0535d5..1d9e33c 100644 --- a/BUILD +++ b/BUILD @@ -12,8 +12,8 @@ # ******************************************************************************* load("@score_cr_checker//:cr_checker.bzl", "copyright_checker") load("@score_dash_license_checker//:dash.bzl", "dash_license_checker") +load("@score_docs_as_code//:docs.bzl", "docs") load("@score_format_checker//:macros.bzl", "use_format_targets") -load("@score_python_basics//:defs.bzl", "score_virtualenv") load("@score_starpls_lsp//:starpls.bzl", "setup_starpls") load("//:project_config.bzl", "PROJECT_CONFIG") @@ -22,12 +22,6 @@ setup_starpls( visibility = ["//visibility:public"], ) -score_virtualenv( - name = "ide_support", - reqs = [], - venv_name = ".venv", -) - copyright_checker( name = "copyright", srcs = [ @@ -50,3 +44,7 @@ dash_license_checker( # Add target for formatting checks use_format_targets() + +docs( + source_dir = "docs", +) diff --git a/MODULE.bazel b/MODULE.bazel index 2af1b49..44009a0 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -33,8 +33,8 @@ bazel_dep(name = "googletest", version = "1.14.0") bazel_dep(name = "rules_rust", version = "0.56.0") # Checker rule for CopyRight checks/fixs -bazel_dep(name = "score_cr_checker", version = "0.2.2") -bazel_dep(name = "score_python_basics", version = "0.3.0") +bazel_dep(name = "score_cr_checker", version = "0.3.1") +bazel_dep(name = "score_python_basics", version = "0.3.4") bazel_dep(name = "score_starpls_lsp", version = "0.1.0") # C/C++ rules for Bazel @@ -58,8 +58,8 @@ bazel_dep(name = "score_dash_license_checker", version = "0.1.2") # Format checker bazel_dep(name = "score_format_checker", version = "0.1.1") -bazel_dep(name = "aspect_rules_lint", version = "1.0.3") -bazel_dep(name = "buildifier_prebuilt", version = "7.3.1") +bazel_dep(name = "aspect_rules_lint", version = "1.4.4") +bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2") #docs-as-code -bazel_dep(name = "score_docs_as_code", version = "0.3.3") +bazel_dep(name = "score_docs_as_code", version = "1.0.1") diff --git a/docs/BUILD b/docs/BUILD deleted file mode 100644 index 45e8692..0000000 --- a/docs/BUILD +++ /dev/null @@ -1,18 +0,0 @@ -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( - # conf_dir = "docs", - docs_targets = [ - { - "suffix": "", # local without external needs - }, - ], - # source_dir = "docs", - source_files_to_scan_for_needs_links = [], -) diff --git a/docs/conf.py b/docs/conf.py index ac60e14..cf13475 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,6 +21,8 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "Module Template Project" +project_url = "https://eclipse-score.github.io/module_template/" +project_prefix = "MODULE_TEMPLATE_" author = "S-CORE" version = "0.1"