Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ user.bazelrc
.ruff_cache

# docs:incremental and docs:ide_support build artifacts
/_build
_build
ubproject.toml

# Vale - editorial style guide
.vale.ini
Expand Down
12 changes: 11 additions & 1 deletion BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,15 @@ docs(
data = [
"@score_process//:needs_json",
],
source_dir = ".",
bundles = [
{
"bundle": "//score/component_example:docs",
"mount_at": "components/component_example",
},
{
"bundle": "//examples:docs",
"mount_at": "examples",
}
],
source_dir = "docs",
)
7 changes: 7 additions & 0 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,10 @@ single_version_override(
module_name = "grpc-java",
version = "1.70.0",
)

# Use latest main, not released yet.
git_override(
module_name = "score_docs_as_code",
commit = "98a078b323fde35fa86d42dc67d75c558ed6c9a8",
remote = "https://github.com/eclipse-score/docs-as-code.git",
)
3,096 changes: 370 additions & 2,726 deletions MODULE.bazel.lock

Large diffs are not rendered by default.

69 changes: 0 additions & 69 deletions conf.py

This file was deleted.

23 changes: 23 additions & 0 deletions docs/components/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
..
# *******************************************************************************
# 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
# *******************************************************************************

.. _ components::

Components
~~~~~~~~~~

.. toctree will be filled by docs_bundle via bazel

.. toctree::
:maxdepth: 1
17 changes: 17 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# *******************************************************************************
# 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
# *******************************************************************************

project = "Module Template Project"
project_url = "https://eclipse-score.github.io/module_template/"

extensions = ["score_sphinx_bundle"]
24 changes: 12 additions & 12 deletions index.rst → docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Overview
This repository provides a standardized setup for projects using **C++** or **Rust** and **Bazel** as a build system.
It integrates best practices for build, test, CI/CD and documentation.
It also provides an example for the documentation of an module with all necessary artifacts for safety and security management, verification and release management.
It also provides an example of modeling architecture in Sphinx Needs in :doc:`/examples/docs/architecture_modeling_example`.
It also provides the component architecture template snippets in :doc:`/score/component_example/docs/architecture/component_architecture`.
It also provides an example of documenting detailed design in :doc:`/score/component_example/docs/detailed_design/detailed_design_example`.
It also provides an example of modeling architecture in Sphinx Needs in :ref:`definition_architectural_design`.
It also provides the component architecture template snippets in :ref:`component_architecture`.
It also provides an example of documenting detailed design in :ref:`detailed_design_example`.

Module Layout
-------------
Expand Down Expand Up @@ -195,23 +195,23 @@ templates and guidelines.>
.. toctree::
:maxdepth: 1

docs/manuals/index
docs/release/release_note
docs/features/index
docs/safety_mgt/index
docs/security_mgt/index
docs/verification_report/module_verification_report
manuals/index
release/release_note
features/index
safety_mgt/index
security_mgt/index
verification_report/module_verification_report


Component Documentation
-----------------------

For documentation of individual components within this module:
For documentation of individual components within this module see:

.. toctree::
:maxdepth: 1

score/component_example/docs/index
components/index

Architecture Modeling Example
-----------------------------
Expand All @@ -221,7 +221,7 @@ An example of modeling architecture in Sphinx Needs can be found in
.. toctree::
:maxdepth: 1

examples/docs/architecture_modeling_example
examples/index

Please note, that is not a template for architecture documentation, but an example of how to use Sphinx Needs for architecture modeling. The architecture documentation of the components and features of the module should follow the provided templates and guidelines.

Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/user_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Integrating with Your Project
Version History, Compatibility, and Troubleshooting
===================================================

For comprehensive information on the following topics, refer to :doc:`/docs/release/release_note`:
For comprehensive information on the following topics, refer to :doc:`/release/release_note`:

* Version history and changes
* Compatibility notes and upgrade instructions
Expand Down
9 changes: 9 additions & 0 deletions examples/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

load("@score_docs_as_code//:docs.bzl", "docs_bundle")

docs_bundle(
name = "docs",
source_dir = "docs",
visibility = ["//visibility:public"],
)

# Needed for Dash tool to check python dependency licenses.
filegroup(
name = "cargo_lock",
Expand Down
23 changes: 23 additions & 0 deletions examples/docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
..
# *******************************************************************************
# 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
# *******************************************************************************

Examples
~~~~~~~~

An example of modeling architecture in Sphinx Needs can be found in

.. toctree::
:maxdepth: 1

architecture_modeling_example
28 changes: 28 additions & 0 deletions score/component_example/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# *******************************************************************************
# 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
# *******************************************************************************

load("@score_docs_as_code//:docs.bzl", "docs_bundle")

filegroup(
name = "all_sources",
srcs = glob(["src/**/*.cpp", "src/**/*.hpp"], allow_empty = True),
)

docs_bundle(
name = "docs",
source_dir = "docs",
scan_code = [
":all_sources",
],
visibility = ["//visibility:public"],
)
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _component_architecture:

Component Architecture Documentation
====================================

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _detailed_design_example:

Example: Detailed Design
========================

Expand Down
Loading