diff options
Diffstat (limited to 'spec-qdp/spec/qdp-sphinx-build.yml')
-rw-r--r-- | spec-qdp/spec/qdp-sphinx-build.yml | 98 |
1 files changed, 98 insertions, 0 deletions
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 |