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
14 changes: 13 additions & 1 deletion BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,24 @@ alias(

# Docs
docs(
bundles = [
{
"bundle": "//score/launch_manager:docs",
"mount_at": "components/launch_manager",
},
{
"bundle": "//score/health_monitor:docs",
"mount_at": "components/health_monitor",
},
],
data = [
"//score/launch_manager/src/daemon/src/configuration/config_schema:config_schema_files",
],
external_needs = [
"@score_platform//:needs_json", # This allows linking to feature requirements.
"@score_process//:needs_json", # This allows linking to requirements (wp__requirements_comp, etc.) from the process_description repository.
],
source_dir = ".",
project = "Lifecycle and Health Management",
project_url = "https://eclipse-score.github.io/lifecycle/",
source_dir = "docs",
)
81 changes: 0 additions & 81 deletions conf.py

This file was deleted.

7 changes: 7 additions & 0 deletions docs/components/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Component documentation
------------------------

.. toctree will be filled by docs_bundle via bazel

.. toctree::
:maxdepth: 1
15 changes: 7 additions & 8 deletions index.rst → docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,20 @@ Module / Feature Documentation
.. toctree::
:maxdepth: 1

docs/features/index
docs/manuals/index
docs/safety_mgt/index
docs/security_mgt/index
docs/release/index
docs/verification_report/statistics
features/index
manuals/index
safety_mgt/index
security_mgt/index
release/index
verification_report/statistics

Component documentation
------------------------

.. toctree::
:maxdepth: 1

score/launch_manager/docs/index
score/health_monitor/docs/index
components/index

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This changes URLs but I guess that is ok for lifecycle as it is unlikely there are many links floating around.



.. _quick-start-building-testing:
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 @@ -115,7 +115,7 @@ Integrating with Your Project
Version History, Compatibility, and Troubleshooting
===================================================

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

* Version history and changes
* Compatibility notes and upgrade instructions
Expand Down
2 changes: 1 addition & 1 deletion docs/release/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************


.. _release_notes:

Release notes
=============
Expand Down
11 changes: 11 additions & 0 deletions score/health_monitor/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************
load("@score_docs_as_code//:docs.bzl", "docs_bundle")

alias(
name = "health_monitoring_cc",
Expand All @@ -22,3 +23,13 @@ alias(
actual = "//score/health_monitor/src/rust:health_monitoring_lib",
visibility = ["//visibility:public"],
)

docs_bundle(
name = "docs",
code_targets = [
":health_monitoring_cc",
":health_monitoring_rust",
],
source_dir = "docs",
visibility = ["//visibility:public"],
)
17 changes: 17 additions & 0 deletions score/launch_manager/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************
load("@rules_cc//cc:defs.bzl", "cc_library")
load("@score_docs_as_code//:docs.bzl", "docs_bundle")
load("//tests/utils/bazel:unit_test.bzl", "lm_cc_test")

package(default_visibility = ["//visibility:public"])
Expand Down Expand Up @@ -132,3 +133,19 @@ alias(
actual = "//score/launch_manager/src/lifecycle_client:runapplication",
)
# END: Fine granular targets only needed for testing purposes

docs_bundle(
name = "docs",
bundles = [
{
"bundle": "//score/launch_manager/src/lifecycle_client:docs",
"mount_at": "subcomponents/lifecycle_client",
},
],
code_targets = [
":launch_manager",
],
data = ["//score/launch_manager/src/daemon/src/configuration/config_schema:config_schema_files"],
source_dir = "docs",
visibility = ["//visibility:public"],
)
2 changes: 1 addition & 1 deletion score/launch_manager/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ Subcomponents
.. toctree::
:titlesonly:

../src/lifecycle_client/docs/index.rst
subcomponents/index
21 changes: 21 additions & 0 deletions score/launch_manager/docs/subcomponents/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
..
# *******************************************************************************
# 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
# *******************************************************************************

Sub-Component documentation
---------------------------

.. toctree will be filled by docs_bundle via bazel

.. toctree::
:maxdepth: 1
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ exports_files(
filegroup(
name = "config_schema_files",
srcs = glob(["**/*.json"]),
visibility = ["//:__pkg__"],
visibility = ["//visibility:public"],
)
10 changes: 10 additions & 0 deletions score/launch_manager/src/lifecycle_client/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
# *******************************************************************************
load("@rules_cc//cc:defs.bzl", "cc_library")
load("@score_baselibs//score/language/safecpp:toolchain_features.bzl", "COMPILER_WARNING_FEATURES")
load("@score_docs_as_code//:docs.bzl", "docs_bundle")
load("//tests/utils/bazel:unit_test.bzl", "lm_cc_test")

cc_library(
Expand Down Expand Up @@ -249,3 +250,12 @@ lm_cc_test(
"@googletest//:gtest_main",
],
)

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