diff options
Diffstat (limited to 'spec-qdp/spec/qdp-sphinx-component.yml')
| -rw-r--r-- | spec-qdp/spec/qdp-sphinx-component.yml | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/spec-qdp/spec/qdp-sphinx-component.yml b/spec-qdp/spec/qdp-sphinx-component.yml new file mode 100644 index 00000000..d0c1748b --- /dev/null +++ b/spec-qdp/spec/qdp-sphinx-component.yml @@ -0,0 +1,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 |