From 67a409eca6cb502bb121d5bc0adc740110d2fabb Mon Sep 17 00:00:00 2001 From: Piotr Korkus Date: Tue, 17 Mar 2026 16:18:28 +0100 Subject: [PATCH] docs: update templates - replace template references with logging --- docs/conf.py | 6 +++--- docs/index.rst | 22 +++++++++++----------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index cf13475..a003cbd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,9 +20,9 @@ # -- Project information ----------------------------------------------------- # 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_" +project = "Logging" +project_url = "https://eclipse-score.github.io/logging/" +project_prefix = "LOG_" author = "S-CORE" version = "0.1" diff --git a/docs/index.rst b/docs/index.rst index 0443c05..b1254a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,10 +12,10 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Module Template Documentation -============================= +Logging Documentation +===================== -This documentation describes the structure, usage and configuration of the Bazel-based C++/Rust module template. +This documentation describes the structure, usage and configuration of the Bazel-based C++/Rust logging module. .. contents:: Table of Contents :depth: 2 @@ -42,13 +42,13 @@ Requirements Project Layout -------------- -The module template includes the following top-level structure: +The logging module includes the following top-level structure: -- `score/`: Main C++/Rust sources -- `tests/`: Unit and integration tests -- `examples/`: Usage examples -- `docs/`: Documentation using `docs-as-code` -- `.github/workflows/`: CI/CD pipelines +- ``score/``: Main C++/Rust sources +- ``tests/``: Unit and integration tests +- ``examples/``: Usage examples +- ``docs/``: Documentation using ``docs-as-code`` +- ``.github/workflows/``: CI/CD pipelines Quick Start ----------- @@ -68,7 +68,7 @@ To run tests: Configuration ------------- -The `project_config.bzl` file defines metadata used by Bazel macros. +The ``project_config.bzl`` file defines metadata used by Bazel macros. Example: @@ -79,7 +79,7 @@ Example: "source_code": ["cpp", "rust"] } -This enables conditional behavior (e.g., choosing `clang-tidy` for C++ or `clippy` for Rust). +This enables conditional behavior (e.g., choosing ``clang-tidy`` for C++ or ``clippy`` for Rust). Decision records ----------------