summaryrefslogtreecommitdiffstats
path: root/spec-qdp/spec/qdp-sphinx-component-glossary.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec-qdp/spec/qdp-sphinx-component-glossary.yml')
-rw-r--r--spec-qdp/spec/qdp-sphinx-component-glossary.yml32
1 files changed, 32 insertions, 0 deletions
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