add requirements (#67)

Co-authored-by: Maximilian Sören Pollak <maximilian.pollak@expleogroup.com>

Author: AlexanderLanin

.vscode/settings.json

@@ -32,5 +32,11 @@
   "python.testing.unittestEnabled": false,
   "python.testing.pytestEnabled": true,
   "bazel.lsp.command": "bazel",
-  "bazel.lsp.args": ["run", "//:starpls_server"]
+  "bazel.lsp.args": [
+    "run",
+    "//:starpls_server"
+  ],
+
+  // Disable internal type checking, since we use basedpyright
+  "python.analysis.typeCheckingMode": "off"
 }

MODULE.bazel

@@ -96,3 +96,4 @@ bazel_dep(name = "score_platform", version = "0.1.1")
 
 # Grab dash
 bazel_dep(name = "score_dash_license_checker", version = "0.1.1")
+bazel_dep(name = "score_process", version = "0.2.0")

docs/BUILD

@@ -31,17 +31,30 @@ docs(
                     "json_url": "https://eclipse-score.github.io/score/main/needs.json",
                     "id_prefix": "score_",
                 },
+                {
+                    "base_url": "https://eclipse-score.github.io/process_description/main",
+                    "json_url": "https://eclipse-score.github.io/process_description/main/needs.json",
+                    "id_prefix": "process_",
+                },
             ],
         },
         {
             "suffix": "release",  # The version imported from MODULE.bazel
-            "target": ["@score_platform//docs:docs_needs"],
+            "target": [
+                "@score_platform//docs:docs_needs",
+                "@score_process//process:docs_needs_latest",
+            ],
             "external_needs_info": [
                 {
                     "base_url": "https://eclipse-score.github.io/score/main",
                     "json_path": "/score_platform~/docs/docs_needs/_build/needs/needs.json",
                     "id_prefix": "score_",
                 },
+                {
+                    "base_url": "https://eclipse-score.github.io/process_description/main",
+                    "json_path": "/score_process~/process/docs_needs_latest/_build/needs/needs.json",
+                    "id_prefix": "process_",
+                },
             ],
         },
     ],

docs/conf.py

@@ -40,6 +40,8 @@
     "score_layout",
 ]
 
+myst_enable_extensions = ["colon_fence"]
+
 exclude_patterns = [
     # The following entries are not required when building the documentation via 'bazel
     # build //docs:docs', as that command runs in a sandboxed environment. However, when

docs/example/index.rst docs/how-to-integrate/example/index.rstdocs/example/index.rst renamed to docs/how-to-integrate/example/index.rst

@@ -30,7 +30,7 @@ This is a rendered example of the 'examples/linking-both' folder using the `docs
 
    Some content to make sure we also can render this
    This is a link to an external need inside the 'score' documentation.
-   :need:`SCORE_feat_req__kvs__config_file`. 
+   :need:`SCORE_feat_req__persistency__config_file`.
    Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here <https://github.com/useblocks/sphinx-needs/blob/master/sphinx_needs/external_needs.py#L119>`_
 
 
@@ -42,8 +42,8 @@ This is a rendered example of the 'examples/linking-both' folder using the `docs
    :safety: ASIL_D
    :satisfies: SCORE_stkh_req__overall_goals__reuse_of_app_soft
    :status: invalid
-   
-   With this requirement we can check if the removal of the prefix is working correctly. 
+
+   With this requirement we can check if the removal of the prefix is working correctly.
    It should remove id_prefix (SCORE _) as it's defined inside the BUILD file and remove it before it checks the leftover value
    against the allowed defined regex in the metamodel
    Note: The ID is different here as the 'folder structure' is as well

docs/example/testing/index.rst …w-to-integrate/example/testing/index.rstdocs/example/testing/index.rst renamed to docs/how-to-integrate/example/testing/index.rst docs/example/testing/index.rst renamed to docs/how-to-integrate/example/testing/index.rst

@@ -23,9 +23,9 @@ This example will help catch things and bugs when rst's are defined inside a fol
    :rationale: A simple requirement we need to enable a documentation build
    :reqtype: Functional
 
-   Some content to make sure we also can render this. 
+   Some content to make sure we also can render this.
    This is a link to an external need inside the 'score' documentation.
-   :need:`SCORE_feat_req__kvs__config_file`. 
+   :need:`SCORE_feat_req__persistency__config_file`.
    Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here <https://github.com/useblocks/sphinx-needs/blob/master/sphinx_needs/external_needs.py#L119>`_
 
 
@@ -35,9 +35,8 @@ This example will help catch things and bugs when rst's are defined inside a fol
    :security: YES
    :safety: ASIL_D
    :satisfies: SCORE_stkh_req__overall_goals__reuse_of_app_soft
-   :status: invalid 
+   :status: invalid
 
-   With this requirement we can check if the removal of the prefix is working correctly. 
+   With this requirement we can check if the removal of the prefix is working correctly.
    It should remove id_prefix (SCORE _) as it's defined inside the BUILD file and remove it before it checks the leftover value
    against the 'allowed' defined regex in the metamodel
-

docs/docs-as-code/getting_started.md docs/how-to-integrate/getting_started.mddocs/docs-as-code/getting_started.md renamed to docs/how-to-integrate/getting_started.md

@@ -95,9 +95,9 @@ bazel build //path/to/BUILD-file:docs_latest # documentation at 'bazel-bin/
 <br>
 <br>
 
-> ### *For the full example as well as more complex ones, check out the {doc}`example <../example/index>`
+> ### *For the full example as well as more complex ones, check out the {doc}`example <example/index>`
 
---- 
+---
 
 ### Available Targets
 
@@ -129,39 +129,3 @@ The `docs()` macro accepts the following arguments:
 | `docs_targets` | List of dictionaries which allows multi-repo setup | Yes | - |
 | `source_files_to_scan_for_needs_links` | List of targets,globs,filegroups that the 'source_code_linker' should parse | No | `[]` |
 | `visibility` | Bazel visibility | No | `None` |
-
---- 
-
-
-## Available Extensions
-This module includes several custom Sphinx extensions to enhance your documentation:
-
-### Score Layout Extension
-
-Custom layout options for Sphinx HTML output are defined in `score_layout`
-<README missing>
-
-### Score Header Service
-
-Consistent header styling across documentation pages.
-{doc}`Learn more <extensions/header_service>`
-
-### Score Metamodel
-
-Validation and checking of documentation structure against a defined Metamodel.
-{doc}`Learn more <extensions/metamodel>`
-
-### Score Source Code Linker
-
-Links between requirements documentation and source code implementations.
-{doc}`Learn more <extensions/source_code_linker.md>
-
-### Score PlantUML
-
-Integration with PlantUML for generating diagrams.
-<README missing>
-
-### Score Draw UML Functions
-
-Helper functions for creating UML diagrams.
-<README missing>

docs/how-to-integrate/index.rst

@@ -0,0 +1,17 @@
+.. _how-to-integrate:
+
+How to Integrate
+==================
+
+
+Here we'll document how to integrate the docs-as-code tooling into your S-CORE repository.
+
+For now here are some :ref:`example <example>` files to get you started.
+
+See also :doc:`getting_started`.
+
+.. toctree::
+   :hidden:
+
+   example/index
+   getting_started

docs/faq/index.rst docs/how-to-use/faq.rstdocs/faq/index.rst renamed to docs/how-to-use/faq.rst

@@ -0,0 +1,12 @@
+.. _how-to-use:
+
+How To Use
+==========
+
+Interesting Links:
+* https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
+
+.. toctree::
+   :hidden:
+
+   faq