17 files changed, 550 insertions, 0 deletions
diff --git a/spec-qdp/spec/qdp-document-license-map.yml b/spec-qdp/spec/qdp-document-license-map.yml
new file mode 100644
index 00000000..6f8d3959
--- /dev/null
+++ b/spec-qdp/spec/qdp-document-license-map.yml
@@ -0,0 +1,25 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2023 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes: {}
+    description: |
+      This set of attributes specifies how SPDX license identifiers are mapped
+      to another SPDX license identifier.  For example, it may be used to map
+      "CC-BY-SA-4.0 OR BSD-2-Clause" to "CC-BY-SA-4.0" for a particular
+      document.
+    generic-attributes:
+      description: null
+      key-spec-type: spdx-license-identifier
+      value-spec-type: spdx-license-identifier
+    mandatory-attributes: all
+spec-name: Document License Map
+spec-type: qdp-document-license-map
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-build.yml b/spec-qdp/spec/qdp-sphinx-build.yml
new file mode 100644
index 00000000..666f5de5
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-build.yml
@@ -0,0 +1,98 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020, 2023 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+- role: spec-refinement
+  spec-key: build-step-type
+  spec-value: sphinx
+  uid: qdp-build-step
+spec-description: |
+  Items of this type shall have the following links:
+
+  * There shall be exactly one link to a ${qdp-directory-state:/spec-name} item
+    with the ${qdp-input-role:/spec-name} and the name ``"source"``.  The link
+    target directory state item defines the source directory of the file copy
+    operation and the list of files to copy.
+
+  * There shall be exactly one link to a ${qdp-directory-state:/spec-name} item
+    with the ${qdp-output-role:/spec-name} and the name ``"build"``.  The link
+    target directory state item defines the build directory.
+
+  * There shall be exactly one link to a ${qdp-directory-state:/spec-name} item
+    with the ${qdp-output-role:/spec-name} and the name ``"destination"``.  The
+    link target directory state item defines the destination directory of the
+    generated output.
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      document-components:
+        description: null
+        spec-type: qdp-sphinx-component-list
+      document-contract:
+        description: |
+          It shall be the document contract reference.
+        spec-type: str
+      document-contributors:
+        description: null
+        spec-type: qdp-sphinx-contributor-action-list
+      document-copyrights:
+        description: |
+          It shall be the list of copyright statements of explicit contributors
+          to the document.  The first contributor on the list is the main
+          contributor.
+        spec-type: copyrights
+      document-html-help-base-name:
+        description: |
+          It shall be the HTML help base name.
+        spec-type: str
+      document-key:
+        description: |
+          It shall be the document key, for example "icd".
+        spec-type: name
+      document-license:
+        description: |
+          It shall be the document license.
+        spec-type: spdx-license-identifier
+      document-license-map:
+        description: |
+          It shall be the document license map.
+        spec-type: qdp-document-license-map
+      document-releases:
+        description: null
+        spec-type: qdp-sphinx-release-list
+      document-title:
+        description: |
+          It shall be the document title.  Use ``$${break}`` to add break hints
+          between words.
+        spec-type: str
+      document-toctree-maxdepth:
+        description: |
+          It shall be the maximum depth of the document table of contents tree.
+        spec-type: int
+      document-type:
+        description: |
+          It shall be the document type.
+        spec-type: str
+      output-html:
+        description: |
+          If the value is present, then it shall be the path to the generated
+          HTML document directory relative to the base directory of the
+          directory state production.
+        spec-type: optional-str
+      output-pdf:
+        description: |
+          If the value is present, then it shall be the path to the generated
+          PDF document relative to the base directory of the directory state
+          production.
+        spec-type: optional-str
+    description: |
+      This set of attributes specifies a document using the Sphinx
+      documentation framework.
+    mandatory-attributes: all
+spec-name: Sphinx Document Build Item Type
+spec-type: qdp-sphinx-build
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-component-copy-and-substitute.yml b/spec-qdp/spec/qdp-sphinx-component-copy-and-substitute.yml
new file mode 100644
index 00000000..a6fbb4c9
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-component-copy-and-substitute.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+- role: spec-refinement
+  spec-key: action
+  spec-value: copy-and-substitute
+  uid: qdp-sphinx-component
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      destination:
+        description: |
+          It shall be the destination path of a Sphinx source file relative to
+          the build directory.
+        spec-type: str
+      source:
+        description: |
+          It shall be the source path of a Sphinx source file relative to the
+          base directory of the directory state dependency.
+        spec-type: str
+    description: |
+      This set of attributes specifies a file to copy for a document using the
+      Sphinx documentation framework.  A variable substitution is performed on
+      the source file.
+    mandatory-attributes: all
+spec-name: Sphinx Document Component Copy and Substitute Action
+spec-type: qdp-sphinx-component-copy-and-substitute
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-component-copy-files.yml b/spec-qdp/spec/qdp-sphinx-component-copy-files.yml
new file mode 100644
index 00000000..af8e8c8d
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-component-copy-files.yml
@@ -0,0 +1,38 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020, 2023 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+- role: spec-refinement
+  spec-key: action
+  spec-value: copy-files
+  uid: qdp-sphinx-component
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      destination:
+        description: |
+          It shall be the path to the destination directory.
+        spec-type: str
+      files:
+        description: |
+          It shall be the list of the files to copy from the source directory
+          to the destination directory.  The files may be specified by a path
+          relative to the source directory.  This relative path is preserved in
+          the destination directory.
+        spec-type: list-str
+      source:
+        description: |
+          It shall be the path to the source directory.
+        spec-type: str
+    description: |
+      This set of attributes specifies a list of files to copy from the source
+      directory to the destination directory.
+    mandatory-attributes: all
+spec-name: Sphinx Document Component Copy Files Action
+spec-type: qdp-sphinx-component-copy-files
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-component-copy.yml b/spec-qdp/spec/qdp-sphinx-component-copy.yml
new file mode 100644
index 00000000..76f86554
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-component-copy.yml
@@ -0,0 +1,33 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+- role: spec-refinement
+  spec-key: action
+  spec-value: copy
+  uid: qdp-sphinx-component
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      destination:
+        description: |
+          It shall be the destination path of a Sphinx source file relative to
+          the build directory.
+        spec-type: str
+      source:
+        description: |
+          It shall be the source path of a Sphinx source file relative to the
+          base directory of the directory state dependency.
+        spec-type: str
+    description: |
+      This set of attributes specifies a file to copy for a document using the
+      Sphinx documentation framework.
+    mandatory-attributes: all
+spec-name: Sphinx Document Component Copy Action
+spec-type: qdp-sphinx-component-copy
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-component-generic.yml b/spec-qdp/spec/qdp-sphinx-component-generic.yml
new file mode 100644
index 00000000..edd9474f
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-component-generic.yml
@@ -0,0 +1,52 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020, 2022 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+- role: spec-refinement
+  spec-key: action
+  spec-value: add-to-index
+  uid: qdp-sphinx-component
+- role: spec-refinement
+  spec-key: action
+  spec-value: known-problems
+  uid: qdp-sphinx-component
+- role: spec-refinement
+  spec-key: action
+  spec-value: requirements
+  uid: qdp-sphinx-component
+- role: spec-refinement
+  spec-key: action
+  spec-value: requirements-and-design
+  uid: qdp-sphinx-component
+- role: spec-refinement
+  spec-key: action
+  spec-value: test-cases
+  uid: qdp-sphinx-component
+- role: spec-refinement
+  spec-key: action
+  spec-value: traceability
+  uid: qdp-sphinx-component
+- role: spec-refinement
+  spec-key: action
+  spec-value: validation
+  uid: qdp-sphinx-component
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      destination:
+        description: |
+          It shall be the destination path of a Sphinx source file relative to
+          the build directory.
+        spec-type: str
+    description: |
+      This set of attributes specifies that a generic action which produces a
+      Sphinx source file for a document using Sphinx documentation framework.
+    mandatory-attributes: all
+spec-name: Sphinx Document Component Generic
+spec-type: qdp-sphinx-component-generic
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-component-glossary.yml b/spec-qdp/spec/qdp-sphinx-component-glossary.yml
new file mode 100644
index 00000000..ad60b1d9
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-component-glossary.yml
@@ -0,0 +1,32 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020, 2022 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+- role: spec-refinement
+  spec-key: action
+  spec-value: glossary
+  uid: qdp-sphinx-component
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      destination:
+        description: |
+          It shall be the destination path of a Sphinx source file relative to
+          the build directory.
+        spec-type: str
+      glossary-groups:
+        description: |
+          It shall be the list of Glossary group identifiers.
+        spec-type: list-uid
+    description: |
+      This set of attributes specifies that a file which should contain the
+      glossary of a document using Sphinx documentation framework.
+    mandatory-attributes: all
+spec-name: Sphinx Document Component Glossary
+spec-type: qdp-sphinx-component-glossary
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-component-list.yml b/spec-qdp/spec/qdp-sphinx-component-list.yml
new file mode 100644
index 00000000..9dbcd269
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-component-list.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  list:
+    description: null
+    spec-type: qdp-sphinx-component
+spec-name: Sphinx Document Component List
+spec-type: qdp-sphinx-component-list
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-component.yml b/spec-qdp/spec/qdp-sphinx-component.yml
new file mode 100644
index 00000000..d0c1748b
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-component.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      action:
+        description: |
+          It shall be the Sphinx component action.
+        spec-type: str
+      add-to-index:
+        description: |
+          It set to true, then the file will be added to the index, otherwise
+          it will not be added to the index.
+        spec-type: bool
+      enabled-by:
+        description: |
+          It shall define the conditions under which the action is enabled.
+        spec-type: enabled-by
+    description: |
+      This set of attributes specifies a component of a document using the
+      Sphinx documentation framework.
+    mandatory-attributes:
+    - action
+    - add-to-index
+spec-name: Sphinx Document Component
+spec-type: qdp-sphinx-component
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-contributor-action-list.yml b/spec-qdp/spec/qdp-sphinx-contributor-action-list.yml
new file mode 100644
index 00000000..4dee8dbd
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-contributor-action-list.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  list:
+    description: null
+    spec-type: qdp-sphinx-contributor-action
+spec-name: Sphinx Document Contributors by Action List
+spec-type: qdp-sphinx-contributor-action-list
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-contributor-action.yml b/spec-qdp/spec/qdp-sphinx-contributor-action.yml
new file mode 100644
index 00000000..f398eb36
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-contributor-action.yml
@@ -0,0 +1,26 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      action:
+        description: |
+          It shall be the action performed by the contributors.
+        spec-type: str
+      contributors:
+        description: null
+        spec-type: qdp-sphinx-contributor-list
+    description: |
+      This set of attributes specifies document contributors which performed a
+      common action.
+    mandatory-attributes: all
+spec-name: Sphinx Document Contributors by Action
+spec-type: qdp-sphinx-contributor-action
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-contributor-list.yml b/spec-qdp/spec/qdp-sphinx-contributor-list.yml
new file mode 100644
index 00000000..4bd4c2d9
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-contributor-list.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  list:
+    description: null
+    spec-type: qdp-sphinx-contributor
+spec-name: Sphinx Document Contributor List
+spec-type: qdp-sphinx-contributor-list
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-contributor.yml b/spec-qdp/spec/qdp-sphinx-contributor.yml
new file mode 100644
index 00000000..cc10bd48
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-contributor.yml
@@ -0,0 +1,26 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      name:
+        description: |
+          It shall be the name of the contributor.
+        spec-type: str
+      organization:
+        description: |
+          It shall be the organization of the contributor.
+        spec-type: str
+    description: |
+      This set of attributes specifies a document contributor.
+    mandatory-attributes: all
+spec-name: Sphinx Document Contributor
+spec-type: qdp-sphinx-contributor
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-release-list.yml b/spec-qdp/spec/qdp-sphinx-release-list.yml
new file mode 100644
index 00000000..76414718
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-release-list.yml
@@ -0,0 +1,16 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  list:
+    description: null
+    spec-type: qdp-sphinx-release
+spec-name: Sphinx Document Release List
+spec-type: qdp-sphinx-release-list
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-release.yml b/spec-qdp/spec/qdp-sphinx-release.yml
new file mode 100644
index 00000000..498a3bd1
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-release.yml
@@ -0,0 +1,31 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      changes:
+        description: |
+          It shall be a summary of the document changes for this release in
+          Sphinx format.  A variable substitution is performed.
+        spec-type: str
+      date:
+        description: |
+          It shall be a document release date.
+        spec-type: str
+      status:
+        description: |
+          It shall be a document release status.
+        spec-type: str
+    description: |
+      This set of attributes specifies a document release.
+    mandatory-attributes: all
+spec-name: Sphinx Document Release
+spec-type: qdp-sphinx-release
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-section.yml b/spec-qdp/spec/qdp-sphinx-section.yml
new file mode 100644
index 00000000..bc6ff494
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-section.yml
@@ -0,0 +1,34 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2023 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+- role: spec-refinement
+  spec-key: qdp-type
+  spec-value: sphinx-section
+  uid: qdp-root
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes:
+      content:
+        description: |
+          It shall be the section content.
+        spec-type: str
+      header:
+        description: |
+          It shall be the section header.
+        spec-type: str
+      label:
+        description: |
+          If the value is present, then it shall be the section label.
+        spec-type: optional-str
+    description: |
+      This set of attributes specifies a Sphinx section.
+    mandatory-attributes: all
+spec-name: Sphinx Section Item Type
+spec-type: qdp-sphinx-section
+type: spec
diff --git a/spec-qdp/spec/qdp-sphinx-types.yml b/spec-qdp/spec/qdp-sphinx-types.yml
new file mode 100644
index 00000000..dfa7c2f8
--- /dev/null
+++ b/spec-qdp/spec/qdp-sphinx-types.yml
@@ -0,0 +1,23 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH & Co. KG
+enabled-by: true
+links:
+- role: spec-member
+  uid: root
+- role: spec-refinement
+  spec-key: document-type
+  spec-value: generic
+  uid: qdp-sphinx-build
+spec-description: null
+spec-example: null
+spec-info:
+  dict:
+    attributes: {}
+    description: |
+      This empty set of attributes is used for refined Sphinx document types
+      which do not need extra attributes.
+    mandatory-attributes: all
+spec-name: Build Sphinx Simple Document Item Types
+spec-type: qdp-sphinx-types
+type: spec