-
Notifications
You must be signed in to change notification settings - Fork 26
change to latest main for new sphinx needs linkage #82
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.
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
RolandJentschETAS
wants to merge
2
commits into
main
Choose a base branch
from
improvement_independend_repositories_sphinx
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -51,5 +51,5 @@ docs( | |
| "@score_platform//:needs_json", | ||
| "@score_process//:needs_json", | ||
| ], | ||
| source_dir = "docs", | ||
| source_dir = ".", | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is not yet supported by docs-as-code. |
||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2024 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 | ||
| # ******************************************************************************* | ||
|
|
||
| # Configuration file for the Sphinx documentation builder. | ||
| # | ||
| # For the full list of built-in configuration values, see the documentation: | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
|
|
||
|
|
||
| # -- Project information ----------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
|
||
| project = "Logging" | ||
| project_url = "https://eclipse-score.github.io/logging/" | ||
| project_prefix = "LOG_" | ||
| author = "S-CORE" | ||
| version = "0.1" | ||
|
|
||
| # -- General configuration --------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration | ||
|
|
||
| root_doc = "index" | ||
|
|
||
| html_context = { | ||
| "doc_path": "", | ||
| } | ||
|
|
||
| extensions = [ | ||
| "sphinx_design", | ||
| "sphinx_needs", | ||
| "sphinxcontrib.plantuml", | ||
| "score_plantuml", | ||
| "score_metamodel", | ||
| "score_draw_uml_funcs", | ||
| "score_source_code_linker", | ||
| "score_layout", | ||
| ] | ||
|
|
||
| exclude_patterns = [ | ||
| # The following entries are not required when building the documentation via 'bazel | ||
| # build //docs:docs', as that command runs in a sandboxed environment. However, when | ||
| # building the documentation via 'bazel run //docs:incremental' or esbonio, these | ||
| # entries are required to prevent the build from failing. | ||
| "bazel-*", | ||
| ".venv_docs", | ||
| ] | ||
|
|
||
| templates_path = ["templates"] | ||
|
|
||
| # Enable numref | ||
| numfig = True |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| Logging Module View | ||
| ################### | ||
|
|
||
|
|
||
| .. mod:: Logging | ||
| :id: mod__logging_repo | ||
| :status: valid | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :includes: comp__data_router, comp__mw_logging | ||
|
|
||
| The logging module provides a standardized logging framework for C++ and Rust projects using Bazel build system. It includes components for log routing allowing for flexible log management and integration with various logging backends. The module is designed to be extensible and configurable to meet the needs of different applications and environments. | ||
|
|
||
| .. mod_view_sta:: Logging module view | ||
| :id: mod_view_sta__logging__logging_view | ||
| :includes: comp__data_router, comp__mw_logging | ||
| :belongs_to: mod__logging | ||
|
|
||
| .. needarch:: | ||
| :scale: 50 | ||
| :align: center | ||
|
|
||
| {{ draw_module(need(), needs) }} | ||
|
|
||
|
|
||
|
|
||
| Logging Feature Architecture | ||
| ############################ | ||
|
|
||
| .. feat_arc_sta:: Feature Architecture Logging | ||
| :id: feat_arc_sta__logging__static_view | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
| :includes: logic_arc_int__logging__logging | ||
| :fulfils: feat_req__logging__log_sources_user_app | ||
| :belongs_to: feat__logging | ||
|
|
||
| .. needarch:: | ||
| :scale: 50 | ||
| :align: center | ||
|
|
||
| {{ draw_component(need(), needs) }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 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 | ||
| # ******************************************************************************* | ||
|
|
||
| Logging Module | ||
| ############## | ||
|
|
||
| Module Documents | ||
| ================ | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
| :maxdepth: 2 | ||
|
|
||
| ./docs/index | ||
|
|
||
| Components | ||
| ========== | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
| :maxdepth: 1 | ||
| :glob: | ||
|
|
||
| ./score/**/docs/index |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
|
|
||
| Data Router Documentation | ||
| ========================= | ||
|
|
||
| This section is reserved for data router-specific documentation. | ||
|
|
||
| .. comp:: Data Router | ||
| :id: comp__data_router | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
| :implements: logic_arc_int__logging__logging | ||
| :belongs_to: feat__logging | ||
|
|
||
| This is the datarouter component responsible for routing log messages to remote Diagnostics Log and Trace (DLT) backend. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| .. | ||
|
rmaddikery marked this conversation as resolved.
|
||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| Logging Documentation | ||
| ======================== | ||
|
|
||
| This section is reserved for middleware-specific documentation. | ||
|
|
||
| .. comp:: Logging Component | ||
| :id: comp__mw_logging | ||
| :security: YES | ||
| :safety: ASIL_B | ||
| :status: valid | ||
| :implements: logic_arc_int__logging__logging | ||
| :belongs_to: feat__logging | ||
|
|
||
| This is the logging component library responsible for selecting the appropriate log sinks based on configuration at runtime. It can perform tasks such as log formatting, filtering, and composite backend selection based on runtime context and configuration. The logging component is designed to be extensible, allowing for custom logging backend to be added as needed. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.