Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
848c63d
docs: add examples user documentation
ryan-steel Jul 15, 2026
853cba3
docs: remove API specifics from the examples docs
ryan-steel Jul 15, 2026
261d68a
feat(docs): Create public user manual for time module
LudwigWeise Jul 15, 2026
c3fd62a
fix(docs): Correct RST structure and apply review feedback
LudwigWeise Jul 16, 2026
094c15e
fix(docs): Integrate user manual into main documentation toctree
LudwigWeise Jul 16, 2026
dac6b19
Merge branch 'docs/document-examples' of https://github.com/etas-cont…
ryan-steel Jul 16, 2026
e9b552b
add user manuals
ryan-steel Jul 17, 2026
fed85cb
chore: address comments
ryan-steel Jul 20, 2026
a2771df
chore: update docs_as_code version and use score_sphinx_bundle
ryan-steel Aug 4, 2026
4ef0e0e
use docs_as_code 6.0 bundles
ryan-steel Aug 5, 2026
96d8f66
chore: format
ryan-steel Aug 5, 2026
61e7a7e
remove include_patterns
ryan-steel Aug 5, 2026
f0ae4bc
chore: address comments
ryan-steel Aug 6, 2026
223f86d
docs: update safety tag to fix build
ryan-steel Aug 6, 2026
6f90324
chore: Merge branch 'main' of https://github.com/etas-contrib/score_t…
ryan-steel Aug 12, 2026
4b65bb2
chore: address comments
ryan-steel Aug 12, 2026
d738c21
docs: use latest module_template layout, update to docs_as_code v7
ryan-steel Aug 12, 2026
6017036
docs: update template IDs for module time
ryan-steel Aug 12, 2026
6cca2e7
chore: update to docs-as-code 7.0.1
ryan-steel Aug 12, 2026
70c6f70
chore: format
ryan-steel Aug 12, 2026
68e56c4
chore: address comments
ryan-steel Aug 14, 2026
4835b25
chore: Merge branch 'main' of https://github.com/etas-contrib/score_t…
ryan-steel Aug 14, 2026
19bcd4b
chore: update docs_as_code to 7.1.0
ryan-steel Aug 14, 2026
db0c9bc
chore: address comments
ryan-steel Aug 14, 2026
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 @@ -40,7 +40,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
20 changes: 18 additions & 2 deletions BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,25 @@ setup_starpls(
)

docs(
data = [
"@score_process//:needs_json",
bundles = [
{
"bundle": "//score/time_slave:docs_bundle",
"mount_at": "components/time_slave",
},
{
"bundle": "//score/time_daemon:docs_bundle",
"mount_at": "components/time_daemon",
},
{
"bundle": "//score/time:docs_bundle",
"mount_at": "components/time",
},
],
external_needs = [
"@score_process//:needs_json_file",
],
project = "S-CORE Time",
project_url = "https://eclipse-score.github.io/time",
source_dir = "docs",
)

Expand Down
6 changes: 2 additions & 4 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
# *******************************************************************************
module(
name = "score_time",
version = "0.0.0",
compatibility_level = 0,
)

## Configure the C++ toolchain
Expand Down Expand Up @@ -69,7 +67,7 @@ bazel_dep(name = "score_logging", version = "0.2.1")

### Modules that are used internally within the repository but not exposed as part of the public API

bazel_dep(name = "score_docs_as_code", version = "4.5.0")
bazel_dep(name = "score_docs_as_code", version = "7.1.0")

bazel_dep(name = "score_cpp_policies", version = "0.0.1", dev_dependency = True)

Expand All @@ -81,7 +79,7 @@ git_override(
remote = "https://github.com/eclipse-score/score_cpp_policies.git",
)

bazel_dep(name = "score_process", version = "1.6.0", dev_dependency = True)
bazel_dep(name = "score_process", version = "2.0.3", dev_dependency = True)
bazel_dep(name = "score_tooling", version = "1.2.0", dev_dependency = True)

# cpp support in use_format_targets(languages=[...]) was added after 1.2.0.
Expand Down
18 changes: 14 additions & 4 deletions MODULE.bazel.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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

Component Classification
========================
.. _ components::

:Component: time_slave
:ASIL Level: QM
:Language: C++
:Platform: Linux, QNX
Components
Comment thread
ryan-steel marked this conversation as resolved.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see the components subfolder in the folder structure document
https://eclipse-score.github.io/score/main/contribute/general/folder.html

so, my question is why it is still here and do we really need it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's in the module template - gives a place for the docs_as_code docs_bundles to be injected.

@anmittag can you confirm whether this will be added to folder.rst?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should keep it, will be adapted in the template

~~~~~~~~~~

.. toctree will be filled by docs_bundle via bazel

.. toctree::
:maxdepth: 1
57 changes: 0 additions & 57 deletions docs/conf.py

This file was deleted.

7 changes: 7 additions & 0 deletions docs/index.rst
Comment thread
ryan-steel marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ For a detailed concept and architectural design, please refer to the :doc:`time_
:caption: Contents:

features/index
module/index

.. toctree::
:maxdepth: 1
:caption: Component Documentation:

components/index

Project Layout
--------------
Expand Down
Empty file removed docs/manuals/.gitkeep
Empty file.
48 changes: 48 additions & 0 deletions docs/module/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
..
# *******************************************************************************
# 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
# *******************************************************************************

Module
======

<Module sphinx documentation template snippets for the module. The directives and their parameters
should be updated according to the module and it's components.>
Comment on lines +18 to +19

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, this needs to be filled by something meaningful ...

Comment on lines +18 to +19

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think, this should be replaced by something meaningful.


.. code-block:: rst

.. mod:: Time
:id: mod__time
:includes: comp__component_name_template

Module View
-----------

.. code-block:: rst

.. mod_view_sta:: Time Module Static View
:id: mod_view_sta__time__time
:includes: comp__component_name_template

.. needarch::
:scale: 50
:align: center

{{ draw_module(need(), needs) }}

Module Documents
----------------

.. toctree::
:maxdepth: 1

manuals/index
Loading
Loading