Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion .bazelrc
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ test --sandbox_tmpfs_path=/tmp
# Tests require to be run in a sandbox. Otherwise some will be flaky.
test --nosandbox_default_allow_network

common --registry=https://raw.githubusercontent.com/eclipse-score/bazel_registry/refs/heads/main/
common --registry=https://raw.githubusercontent.com/eclipse-score/bazel_registry/main/
common --registry=https://bcr.bazel.build

# With this instrumentation filter for our two main components, we ensure that `bazel coverage //...` is yielding the correct results
Expand All @@ -78,3 +78,8 @@ test:clang-tidy --output_groups=+rules_lint_report
test:clang-tidy --extra_toolchains=@llvm_toolchain//:cc-toolchain-x86_64-linux

import quality/sanitizer/sanitizer.bazelrc

build --java_language_version=17
build --java_runtime_version=remotejdk_17
build --tool_java_language_version=17
build --tool_java_runtime_version=remotejdk_17
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ user.bazelrc
.cache/*
compile_commands.json
rust-project.json

# docs build artifacts
/_build*
docs/ubproject.toml
4 changes: 4 additions & 0 deletions BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
load("@aspect_rules_lint//format:defs.bzl", "format_multirun", "format_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@score_tooling//:defs.bzl", "copyright_checker")
load("@score_docs_as_code//:docs.bzl", "docs")

docs(source_dir = "docs")


compile_pip_requirements(
name = "pip_requirements",
Expand Down
3 changes: 2 additions & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ doxygen_extension = use_extension("@rules_doxygen//:extensions.bzl", "doxygen_ex
use_repo(doxygen_extension, "doxygen")

# Python 3.12 toolchain for Bazel
bazel_dep(name = "rules_python", version = "1.5.1")
bazel_dep(name = "rules_python", version = "1.4.1")

python = use_extension("@rules_python//python/extensions:python.bzl", "python")
python.toolchain(
Expand Down Expand Up @@ -217,3 +217,4 @@ use_repo(apt, "ubuntu24_04")
bazel_dep(name = "rules_pkg", version = "1.1.0")

bazel_dep(name = "score_tooling", version = "1.0.4")
bazel_dep(name = "score_docs_as_code", version = "2.2.0")
22 changes: 22 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

project = "Score Communication"
project_url = "https://eclipse-score.github.io/score-communication/"
version = "0.1"

extensions = [
# TODO remove plantuml here once docs-as-code is updated to sphinx-needs 6
"sphinxcontrib.plantuml",
"score_sphinx_bundle",
]
28 changes: 28 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. # *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************


Communication Documentation
===========================

Welcome to the Communication documentation.

.. contents:: Table of Contents
:depth: 2
:local:

Purpose
-------

Summary
-------
Loading