blob: 666f5de5e7100f69c180a9b29147e3e397894077 (
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
|
