github/open-cas-linux
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Introduce reqparse, the plain text requirement parser

Browse Source 
Signed-off-by: Robert Baldyga <robert.baldyga@intel.com>
This commit is contained in:
Robert Baldyga
2021-02-03 19:35:42 +01:00
parent ff00dab04c
commit a901475f1b
2 changed files with 195 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
doc/requirement_example Normal file
View File

@@ -0,0 +1,42 @@
---
group: Requirement group title
---
Requirement group description.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
title: Requirement about requirements
id: req_syntax
---
It shall be possible specify requirement header and body.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
title: Markdown in requirements body
id: req_body_markdown
---
It shall be possible use markdown language in requirement body.
The feature list includes:
- **bold**, *italics* text
- ordered and unordered lists
- tables
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
title: YAML in requirements header
id: req_header_yaml
---
It shall be possible to put any YAML content in the requirement header
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
title: Multiple requirements
id: multiple_requirements
---
It shall be possible to place multiple requirements in one file.