Skip to content

docs: update templates #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PiotrKorkus wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update templates #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
22 changes: 11 additions & 11 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
-----------
Expand All @@ -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:

Expand All @@ -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
----------------
Expand Down
Loading