Skip to content

Commit 1451584

Browse files
authored
docs: update templates (#74)
- replace template references with logging
1 parent 2833f5d commit 1451584

2 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020
# -- Project information -----------------------------------------------------
2121
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
2222

23-
project = "Module Template Project"
24-
project_url = "https://eclipse-score.github.io/module_template/"
25-
project_prefix = "MODULE_TEMPLATE_"
23+
project = "Logging"
24+
project_url = "https://eclipse-score.github.io/logging/"
25+
project_prefix = "LOG_"
2626
author = "S-CORE"
2727
version = "0.1"
2828

docs/index.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
Module Template Documentation
16-
=============================
15+
Logging Documentation
16+
=====================
1717

18-
This documentation describes the structure, usage and configuration of the Bazel-based C++/Rust module template.
18+
This documentation describes the structure, usage and configuration of the Bazel-based C++/Rust logging module.
1919

2020
.. contents:: Table of Contents
2121
:depth: 2
@@ -42,13 +42,13 @@ Requirements
4242
Project Layout
4343
--------------
4444

45-
The module template includes the following top-level structure:
45+
The logging module includes the following top-level structure:
4646

47-
- `score/`: Main C++/Rust sources
48-
- `tests/`: Unit and integration tests
49-
- `examples/`: Usage examples
50-
- `docs/`: Documentation using `docs-as-code`
51-
- `.github/workflows/`: CI/CD pipelines
47+
- ``score/``: Main C++/Rust sources
48+
- ``tests/``: Unit and integration tests
49+
- ``examples/``: Usage examples
50+
- ``docs/``: Documentation using ``docs-as-code``
51+
- ``.github/workflows/``: CI/CD pipelines
5252

5353
Quick Start
5454
-----------
@@ -68,7 +68,7 @@ To run tests:
6868
Configuration
6969
-------------
7070

71-
The `project_config.bzl` file defines metadata used by Bazel macros.
71+
The ``project_config.bzl`` file defines metadata used by Bazel macros.
7272

7373
Example:
7474

@@ -79,7 +79,7 @@ Example:
7979
"source_code": ["cpp", "rust"]
8080
}
8181
82-
This enables conditional behavior (e.g., choosing `clang-tidy` for C++ or `clippy` for Rust).
82+
This enables conditional behavior (e.g., choosing ``clang-tidy`` for C++ or ``clippy`` for Rust).
8383

8484
Decision records
8585
----------------

0 commit comments

Comments
 (0)