Skip to content
Open
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 @@ -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
4 changes: 2 additions & 2 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,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.0.1")

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

Expand All @@ -81,7 +81,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
15 changes: 12 additions & 3 deletions MODULE.bazel.lock

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

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

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'm a bit struggling, why dowe have this subfoler here...

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.

This was added following the guide for docs_as_code (and to follow the module_template). I think the module template is more up-to-date than the folder structure layout in the platform docs, but they're inconsistent so we need to follow one as a single source of truth.

I think we should use the module_template as the source of truth since it's the one that's being worked on actively. Thoughts?

~~~~~~~~~~

.. 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
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
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.>

.. 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