blob: d0c1748bfa78098b75759460901404b598103144 (
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
33
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
|
