Skip to content

Commit 3f06577

Browse files
committed
Extend documentation
1 parent d3808b4 commit 3f06577

File tree

6 files changed

+33
-5
lines changed

6 files changed

+33
-5
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ __pycache__/
2121
# Docs
2222
/_build
2323
/docs/ubproject.toml
24+
/docs/_collections

BUILD

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ load("@score_docs_as_code//:docs.bzl", "docs")
1616
docs(
1717
data = [
1818
"@score_platform//:needs_json",
19+
#"@score_persistency//:needs_json", # cannot be included, as it does not contain any needs?
20+
#"@score_orchestrator//:needs_json", # some issue about score_toolchains_qnx?
21+
#"@score_communication//:needs_json", # no docs yet?
22+
"@score_feo//:needs_json",
23+
"@score_docs_as_code//:needs_json",
1924
"@score_process//:needs_json",
20-
# Persistency cannot be included, as it does not contain any needs.
21-
# -> sphinx-needs bug?
22-
# "@score_persistency//:needs_json",
2325
],
2426
source_dir = "docs",
2527
)

docs/index.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,21 @@ Release Notes: :need:`doc__score_v05_alpha_release_note`
2020

2121
.. if-collection:: score_platform
2222

23-
Documentation:
24-
2523
.. toctree::
2624
:maxdepth: 1
2725
:titlesonly:
26+
:caption: Platform and Modules
2827

2928
S-CORE Platform <_collections/score_platform/docs/index>
29+
place_holder/persistency
30+
place_holder/orchestrator
31+
place_holder/communication
32+
FEO <_collections/score_feo/docs/index>
33+
34+
.. toctree::
35+
:maxdepth: 1
36+
:titlesonly:
37+
:caption: Process, Methods, and Tools
38+
3039
_collections/score_process/process/index
40+
_collections/score_docs_as_code/docs/index
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
=============
2+
Communication
3+
=============
4+
5+
No communication available yet.

docs/place_holder/orchestrator.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
============
2+
Orchestrator
3+
============
4+
5+
Actual documentation is found here: https://eclipse-score.github.io/orchestrator/main/

docs/place_holder/persistency.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
===========
2+
Persistency
3+
===========
4+
5+
Actual documentation is found here: https://eclipse-score.github.io/persistency/main/

0 commit comments

Comments
 (0)