summaryrefslogtreecommitdiff
path: root/spec-qdp/spec/qdp-sphinx-component-glossary.yml
blob: ad60b1d90e3ad600f80fcf5f6a7cbf2e71f70f8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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