File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 2020# -- Project information -----------------------------------------------------
2121# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
2222
23- project = "Module Template Project "
23+ project = "Bazel Tools Python "
2424project_url = "https://eclipse-score.github.io/module_template/"
2525project_prefix = "MODULE_TEMPLATE_"
2626author = "S-CORE"
Original file line number Diff line number Diff line change 1212 # SPDX-License-Identifier: Apache-2.0
1313 # *******************************************************************************
1414
15- Module Template Documentation
15+ Bazel Tools Python
1616=============================
1717
18- This documentation describes the structure, usage and configuration of the Bazel-based C++/Rust module template.
19-
20- .. contents :: Table of Contents
21- :depth: 2
22- :local:
23-
24- Overview
25- --------
26-
27- This repository provides a standardized setup for projects using **C++ ** or **Rust ** and **Bazel ** as a build system.
28- It integrates best practices for build, test, CI/CD and documentation.
29-
30- Requirements
31- ------------
32-
33- .. stkh_req :: Example Functional Requirement
34- :id: stkh_req__docgen_enabled__example
35- :status: valid
36- :safety: QM
37- :reqtype: Functional
38- :rationale: Ensure documentation builds are possible for all modules
39-
40-
41- Project Layout
42- --------------
43-
44- The module template includes the following top-level structure:
45-
46- - `src/ `: Main C++/Rust sources
47- - `tests/ `: Unit and integration tests
48- - `examples/ `: Usage examples
49- - `docs/ `: Documentation using `docs-as-code `
50- - `.github/workflows/ `: CI/CD pipelines
51-
52- Quick Start
53- -----------
54-
55- To build the module:
56-
57- .. code-block :: bash
58-
59- bazel build //src/...
60-
61- To run tests:
62-
63- .. code-block :: bash
64-
65- bazel test //tests/...
66-
67- Configuration
68- -------------
69-
70- The `project_config.bzl ` file defines metadata used by Bazel macros.
71-
72- Example:
73-
74- .. code-block :: python
75-
76- PROJECT_CONFIG = {
77- " asil_level" : " QM" ,
78- " source_code" : [" cpp" , " rust" ]
79- }
80-
81- This enables conditional behavior (e.g., choosing `clang-tidy ` for C++ or `clippy ` for Rust).
18+ Please check the project README for the project configuration.
You can’t perform that action at this time.
0 commit comments