Analysis¶
All elements¶
Table¶
ID |
Title |
Type |
|---|---|---|
Sphinx-Needs needs.json file |
artifact |
|
rst file |
artifact |
|
ubc needs.json file |
artifact |
|
Do not use dynamic functions |
restriction |
|
Do not use dynamic functions |
restriction |
|
Do not use list2needs |
restriction |
|
Do not use/reference rst files outside the ubproject workspace/scope |
restriction |
|
Needed folders/files are ignored |
error |
|
Programmatic errors in rst/md files result in ignored Traceability objects |
error |
|
Content contains syntax errors |
error |
|
Invalid meta-data in rst/md files leads to ignored Traceability objects |
error |
|
Dynamic functions return invalid meta-data |
error |
|
Function returns invalid value |
error |
|
Function gets not executed |
error |
|
Dynamic functions return wrong meta-data |
error |
|
Function returns wrong calculated values |
error |
|
Traceability objects meta-data corrupted |
error |
|
Corrupted external needs.json file |
error |
|
Invalid or incorrect filters used for external needs.json |
error |
|
Objects missing in needs.json |
error |
|
Missing external needs.json file |
error |
|
Meta-data missing |
error |
|
Wrong meta-data is used |
error |
|
External needs corrupted |
error |
|
Links missing |
error |
|
Back-links are not set |
error |
|
External needs not found |
error |
|
Internal target link is not found |
error |
|
Sphinx-Needs data not valid |
error |
|
Sphinx-Needs data is not process-compliant |
error |
|
Authentication issues with needsservice |
error |
|
External service unreachable by needsservice |
error |
|
needsservice unable to process data from external service |
error |
|
Syntax errors in rst/md files cause Traceability objects to be ignored |
error |
|
Access to files/folders not given |
error |
|
Needed files/folders have not supported encoding |
error |
|
Format introduces errors |
error |
|
Incomplete data |
error |
|
Not covered format |
error |
|
Unknown file format |
error |
|
Incomplete Validation |
error |
|
Display Traceability objects content in Sphinx-Needs |
feature |
|
Generate object representation in Sphinx-Needs |
feature |
|
Apply dynamic functions for meta-data computation |
feature |
|
Export needs.json file using Sphinx-Needs |
feature |
|
Establish links between Traceability objects in Sphinx-Needs |
feature |
|
Read Traceability objects in Sphinx-Needs |
feature |
|
Assign meta-data to Traceability objects in Sphinx-Needs |
feature |
|
Enhance Need content using templates in Sphinx-Needs |
feature |
|
Extend page content with templates in Sphinx-Needs |
feature |
|
Attention Admonition |
feature |
|
Caution Admonition |
feature |
|
Danger Admonition |
feature |
|
Error Admonition |
feature |
|
Generic Admonition |
feature |
|
Hint Admonition |
feature |
|
Important Admonition |
feature |
|
Note Admonition |
feature |
|
Tip Admonition |
feature |
|
Warning Admonition |
feature |
|
Built-in HTML Search |
feature |
|
Static File Support |
feature |
|
HTML Theming Support |
feature |
|
Block Quotes |
feature |
|
Line Blocks |
feature |
|
Code Block Directive |
feature |
|
Contents Directive (Local ToC) |
feature |
|
CSV Table Directive |
feature |
|
Figure Directive |
feature |
|
Image Directive |
feature |
|
Include Directive |
feature |
|
List Table Directive |
feature |
|
Literal Include Directive |
feature |
|
Math Directive |
feature |
|
Raw Content Directive |
feature |
|
Rubric Directive |
feature |
|
Table Directive with Title |
feature |
|
Table of Contents Tree Directive (toctree) |
feature |
|
Italicized (Emphasis) Text |
feature |
|
Escaped Markup Characters |
feature |
|
Inline Internal Target |
feature |
|
Inline Literal (Code) Text |
feature |
|
Named Hyperlink Reference |
feature |
|
Bold (Strong) Text |
feature |
|
Citations |
feature |
|
Explicit Target Creation |
feature |
|
External Hyperlinks |
feature |
|
Footnotes |
feature |
|
Implicit Hyperlinks from URLs |
feature |
|
Internal Cross-References to Labels |
feature |
|
Auto-Numbered Lists |
feature |
|
Bulleted Lists |
feature |
|
Definition Lists |
feature |
|
Numbered (Enumerated) Lists |
feature |
|
Nested Lists |
feature |
|
Option Lists |
feature |
|
Automatic ID generation |
feature |
|
Configuration via conf.py or an external TOML file |
feature |
|
Customizable layouts for need presentation |
feature |
|
Customizable link types |
feature |
|
Customizable need options |
feature |
|
Definable need types |
feature |
|
Create a bar chart based on need statistics (needbar) |
feature |
|
Modify existing needs in bulk (needextend) |
feature |
|
Render a PlantUML flow diagram of needs (needflow) |
feature |
|
Import needs from an external JSON file (needimport) |
feature |
|
Create a pie chart based on need statistics (needpie) |
feature |
|
Display needs in a filterable table (needtable) |
feature |
|
Constraint checking to validate need relationships |
feature |
|
JSON builder to export all need data |
feature |
|
Permalink generation to specific need objects |
feature |
|
Bidirectional link tracking |
feature |
|
Dead link detection and warnings |
feature |
|
Direct linking between needs using IDs |
feature |
|
Manual ID assignment |
feature |
|
In-content need parts for granular references |
feature |
|
Need status enforcement |
feature |
|
Tagging support |
feature |
|
Unique ID enforcement and checks |
feature |
|
Directory HTML Output |
feature |
|
ePub 3 Output |
feature |
|
Gettext Message Catalog Output |
feature |
|
HTML Output |
feature |
|
JSON Output |
feature |
|
LaTeX Output |
feature |
|
Man Page Output |
feature |
|
Single-File HTML Output |
feature |
|
Plain Text Output |
feature |
|
Read-in documents with Sphinx |
feature |
|
Code Role |
feature |
|
Document Role |
feature |
|
Emphasis Role |
feature |
|
Literal Role |
feature |
|
Inline Math Role |
feature |
|
Numbered Reference Role |
feature |
|
Reference Role |
feature |
|
Strong Role |
feature |
|
Subscript Role |
feature |
|
Superscript Role |
feature |
|
Document Title and Subtitle |
feature |
|
Section Titles with Underlines |
feature |
|
Transitions (Horizontal Lines) |
feature |
|
Grid Tables |
feature |
|
Simple Tables |
feature |
|
Build needs.json |
feature |
|
Clean internal caches |
feature |
|
Format rst files |
feature |
|
Check rst files for linting problems |
feature |
|
Validate needs.json |
feature |
|
Clean full build |
restriction |
|
Warning to Error |
restriction |
|
Clean full build |
restriction |
|
Warning to Error |
restriction |
|
Sphinx-Needs |
tool |
|
Sphinx |
tool |
|
Sphinx-Test-Reports |
tool |
|
ubc |
tool |
|
ubCode |
tool |
|
ubTrace |
tool |
|
Document SW Detail Design (SW API) |
usecase |
|
Document SW architecture |
usecase |
|
Document software qualification tests and results |
usecase |
|
Document software requirements |
usecase |
|
Document SW Unit test cases |
usecase |
|
Document Test results of SW Unit tests |
usecase |
Flowchart¶
![@startuml
' Nodes definition
file "<size:12>Artifact</size>\n**Sphinx-Needs**\n**needs.json file**\n<size:10>ART_SN_NEEDS_JSON</size>" as ART_SN_NEEDS_JSON [[../tools/sphinx-needs/artifacts.html#ART_SN_NEEDS_JSON]] #LightBlue
rectangle "<size:12>Feature</size>\n**Read**\n**Traceability**\n**objects in**\n**Sphinx-Needs**\n<size:10>FE_SN_READ</size>" as FE_SN_READ [[../tools/sphinx-needs/features.html#FE_SN_READ]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Syntax errors**\n**in rst/md files**\n**cause**\n**Traceability**\n**objects to be**\n**ignored**\n<size:10>ER_SN_SYN_ER</size>" as ER_SN_SYN_ER [[../tools/sphinx-needs/features.html#ER_SN_SYN_ER]] #Pink
rectangle "<size:12>Error</size>\n**Missing**\n**external**\n**needs.json file**\n<size:10>ER_SN_JSON_NOT_FOUND</size>" as ER_SN_JSON_NOT_FOUND [[../tools/sphinx-needs/features.html#ER_SN_JSON_NOT_FOUND]] #Pink
rectangle "<size:12>Error</size>\n**Corrupted**\n**external**\n**needs.json file**\n<size:10>ER_SN_JSON_CORRUPTED</size>" as ER_SN_JSON_CORRUPTED [[../tools/sphinx-needs/features.html#ER_SN_JSON_CORRUPTED]] #Pink
rectangle "<size:12>Error</size>\n**Authentication**\n**issues with**\n**needsservice**\n<size:10>ER_SN_SER_AUTH</size>" as ER_SN_SER_AUTH [[../tools/sphinx-needs/features.html#ER_SN_SER_AUTH]] #Pink
rectangle "<size:12>Error</size>\n**Invalid meta-**\n**data in rst/md**\n**files leads to**\n**ignored**\n**Traceability**\n**objects**\n<size:10>ER_SN_DATA_INVALID</size>" as ER_SN_DATA_INVALID [[../tools/sphinx-needs/features.html#ER_SN_DATA_INVALID]] #Pink
rectangle "<size:12>Error</size>\n**Programmatic**\n**errors in**\n**rst/md files**\n**result in**\n**ignored**\n**Traceability**\n**objects**\n<size:10>ER_SN_CODE_ERR</size>" as ER_SN_CODE_ERR [[../tools/sphinx-needs/features.html#ER_SN_CODE_ERR]] #Pink
rectangle "<size:12>Error</size>\n**Invalid or**\n**incorrect**\n**filters used**\n**for external**\n**needs.json**\n<size:10>ER_SN_JSON_FILTER</size>" as ER_SN_JSON_FILTER [[../tools/sphinx-needs/features.html#ER_SN_JSON_FILTER]] #Pink
rectangle "<size:12>Error</size>\n**External**\n**service**\n**unreachable by**\n**needsservice**\n<size:10>ER_SN_SER_DOWN</size>" as ER_SN_SER_DOWN [[../tools/sphinx-needs/features.html#ER_SN_SER_DOWN]] #Pink
rectangle "<size:12>Error</size>\n**needsservice**\n**unable to**\n**process data**\n**from external**\n**service**\n<size:10>ER_SN_SER_INVALID</size>" as ER_SN_SER_INVALID [[../tools/sphinx-needs/features.html#ER_SN_SER_INVALID]] #Pink
}
rectangle "<size:12>Feature</size>\n**Display**\n**Traceability**\n**objects content**\n**in Sphinx-Needs**\n<size:10>FE_SN_CONTENT_RENDER</size>" as FE_SN_CONTENT_RENDER [[../tools/sphinx-needs/features.html#FE_SN_CONTENT_RENDER]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Content**\n**contains syntax**\n**errors**\n<size:10>ER_SN_CONTENT_SYNTAX</size>" as ER_SN_CONTENT_SYNTAX [[../tools/sphinx-needs/features.html#ER_SN_CONTENT_SYNTAX]] #Pink
}
rectangle "<size:12>Feature</size>\n**Assign meta-**\n**data to**\n**Traceability**\n**objects in**\n**Sphinx-Needs**\n<size:10>FE_SN_SET_META</size>" as FE_SN_SET_META [[../tools/sphinx-needs/features.html#FE_SN_SET_META]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Dynamic**\n**functions**\n**return invalid**\n**meta-data**\n<size:10>ER_SN_DYN_INVALID</size>" as ER_SN_DYN_INVALID [[../tools/sphinx-needs/features.html#ER_SN_DYN_INVALID]] #Pink
rectangle "<size:12>Error</size>\n**Dynamic**\n**functions**\n**return wrong**\n**meta-data**\n<size:10>ER_SN_DYN_WRONG</size>" as ER_SN_DYN_WRONG [[../tools/sphinx-needs/features.html#ER_SN_DYN_WRONG]] #Pink
rectangle "<size:12>Error</size>\n**Sphinx-Needs**\n**data not valid**\n<size:10>ER_SN_META_INVALID</size>" as ER_SN_META_INVALID [[../tools/sphinx-needs/features.html#ER_SN_META_INVALID]] #Pink
rectangle "<size:12>Error</size>\n**Sphinx-Needs**\n**data is not**\n**process-**\n**compliant**\n<size:10>ER_SN_META_NOT_COMPLIANT</size>" as ER_SN_META_NOT_COMPLIANT [[../tools/sphinx-needs/features.html#ER_SN_META_NOT_COMPLIANT]] #Pink
}
rectangle "<size:12>Feature</size>\n**Establish links**\n**between**\n**Traceability**\n**objects in**\n**Sphinx-Needs**\n<size:10>FE_SN_LINK</size>" as FE_SN_LINK [[../tools/sphinx-needs/features.html#FE_SN_LINK]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Back-links are**\n**not set**\n<size:10>ER_SN_LINKS_NO_BACK</size>" as ER_SN_LINKS_NO_BACK [[../tools/sphinx-needs/features.html#ER_SN_LINKS_NO_BACK]] #Pink
rectangle "<size:12>Error</size>\n**Internal target**\n**link is not**\n**found**\n<size:10>ER_SN_LINKS_NO_TARGET</size>" as ER_SN_LINKS_NO_TARGET [[../tools/sphinx-needs/features.html#ER_SN_LINKS_NO_TARGET]] #Pink
rectangle "<size:12>Error</size>\n**External needs**\n**not found**\n<size:10>ER_SN_LINKS_NO_EXT</size>" as ER_SN_LINKS_NO_EXT [[../tools/sphinx-needs/features.html#ER_SN_LINKS_NO_EXT]] #Pink
rectangle "<size:12>Error</size>\n**External needs**\n**corrupted**\n<size:10>ER_SN_LINKS_EXT_COR</size>" as ER_SN_LINKS_EXT_COR [[../tools/sphinx-needs/features.html#ER_SN_LINKS_EXT_COR]] #Pink
rectangle "<size:12>Error</size>\n**Links missing**\n<size:10>ER_SN_LINKS_MISSING</size>" as ER_SN_LINKS_MISSING [[../tools/sphinx-needs/features.html#ER_SN_LINKS_MISSING]] #Pink
}
rectangle "<size:12>Feature</size>\n**Generate object**\n**representation**\n**in Sphinx-Needs**\n<size:10>FE_SN_DOCTREE</size>" as FE_SN_DOCTREE [[../tools/sphinx-needs/features.html#FE_SN_DOCTREE]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Meta-data**\n**missing**\n<size:10>ER_SN_LAY_META_MIS</size>" as ER_SN_LAY_META_MIS [[../tools/sphinx-needs/features.html#ER_SN_LAY_META_MIS]] #Pink
rectangle "<size:12>Error</size>\n**Wrong meta-data**\n**is used**\n<size:10>ER_SN_LAY_META_WRONG</size>" as ER_SN_LAY_META_WRONG [[../tools/sphinx-needs/features.html#ER_SN_LAY_META_WRONG]] #Pink
}
rectangle "<size:12>Feature</size>\n**Export**\n**needs.json file**\n**using Sphinx-**\n**Needs**\n<size:10>FE_SN_JSON</size>" as FE_SN_JSON [[../tools/sphinx-needs/features.html#FE_SN_JSON]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Objects missing**\n**in needs.json**\n<size:10>ER_SN_JSON_MIS</size>" as ER_SN_JSON_MIS [[../tools/sphinx-needs/features.html#ER_SN_JSON_MIS]] #Pink
rectangle "<size:12>Error</size>\n**Traceability**\n**objects meta-**\n**data corrupted**\n<size:10>ER_SN_JSON_COR</size>" as ER_SN_JSON_COR [[../tools/sphinx-needs/features.html#ER_SN_JSON_COR]] #Pink
}
rectangle "<size:12>Feature</size>\n**Apply dynamic**\n**functions for**\n**meta-data**\n**computation**\n<size:10>FE_SN_DYN_FUNC</size>" as FE_SN_DYN_FUNC [[../tools/sphinx-needs/features.html#FE_SN_DYN_FUNC]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Function gets**\n**not executed**\n<size:10>ER_SN_DYN_NO_EXEC</size>" as ER_SN_DYN_NO_EXEC [[../tools/sphinx-needs/features.html#ER_SN_DYN_NO_EXEC]] #Pink
rectangle "<size:12>Error</size>\n**Function**\n**returns invalid**\n**value**\n<size:10>ER_SN_DYN_INVALID2</size>" as ER_SN_DYN_INVALID2 [[../tools/sphinx-needs/features.html#ER_SN_DYN_INVALID2]] #Pink
rectangle "<size:12>Error</size>\n**Function**\n**returns wrong**\n**calculated**\n**values**\n<size:10>ER_SN_DYN_WRONG_CALC</size>" as ER_SN_DYN_WRONG_CALC [[../tools/sphinx-needs/features.html#ER_SN_DYN_WRONG_CALC]] #Pink
}
rectangle "<size:12>Feature</size>\n**Extend page**\n**content with**\n**templates in**\n**Sphinx-Needs**\n<size:10>FE_SN_TEMPLATE_PAGE</size>" as FE_SN_TEMPLATE_PAGE [[../tools/sphinx-needs/features.html#FE_SN_TEMPLATE_PAGE]] #Gold
rectangle "<size:12>Feature</size>\n**Enhance Need**\n**content using**\n**templates in**\n**Sphinx-Needs**\n<size:10>FE_SN_TEMPLATE_NEED</size>" as FE_SN_TEMPLATE_NEED [[../tools/sphinx-needs/features.html#FE_SN_TEMPLATE_NEED]] #Gold
rectangle "<size:12>Feature</size>\n**Definable need**\n**types**\n<size:10>FE_SPHINX_NEEDS_DEFINABLE_TYPES</size>" as FE_SPHINX_NEEDS_DEFINABLE_TYPES [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_DEFINABLE_TYPES]] #Gold
rectangle "<size:12>Feature</size>\n**Customizable**\n**need options**\n<size:10>FE_SPHINX_NEEDS_CUSTOMIZABLE_OPTIONS</size>" as FE_SPHINX_NEEDS_CUSTOMIZABLE_OPTIONS [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_CUSTOMIZABLE_OPTIONS]] #Gold
rectangle "<size:12>Feature</size>\n**Customizable**\n**link types**\n<size:10>FE_SPHINX_NEEDS_CUSTOMIZABLE_LINKS</size>" as FE_SPHINX_NEEDS_CUSTOMIZABLE_LINKS [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_CUSTOMIZABLE_LINKS]] #Gold
rectangle "<size:12>Feature</size>\n**Automatic ID**\n**generation**\n<size:10>FE_SPHINX_NEEDS_AUTO_ID</size>" as FE_SPHINX_NEEDS_AUTO_ID [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_AUTO_ID]] #Gold
rectangle "<size:12>Feature</size>\n**Manual ID**\n**assignment**\n<size:10>FE_SPHINX_NEEDS_MANUAL_ID</size>" as FE_SPHINX_NEEDS_MANUAL_ID [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_MANUAL_ID]] #Gold
rectangle "<size:12>Feature</size>\n**Need status**\n**enforcement**\n<size:10>FE_SPHINX_NEEDS_STATUS_ENFORCEMENT</size>" as FE_SPHINX_NEEDS_STATUS_ENFORCEMENT [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_STATUS_ENFORCEMENT]] #Gold
rectangle "<size:12>Feature</size>\n**Tagging support**\n<size:10>FE_SPHINX_NEEDS_TAGGING</size>" as FE_SPHINX_NEEDS_TAGGING [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_TAGGING]] #Gold
rectangle "<size:12>Feature</size>\n**In-content need**\n**parts for**\n**granular**\n**references**\n<size:10>FE_SPHINX_NEEDS_NEED_PARTS</size>" as FE_SPHINX_NEEDS_NEED_PARTS [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_NEED_PARTS]] #Gold
rectangle "<size:12>Feature</size>\n**Unique ID**\n**enforcement and**\n**checks**\n<size:10>FE_SPHINX_NEEDS_UNIQUE_ID_ENFORCEMENT</size>" as FE_SPHINX_NEEDS_UNIQUE_ID_ENFORCEMENT [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_UNIQUE_ID_ENFORCEMENT]] #Gold
rectangle "<size:12>Feature</size>\n**Display needs**\n**in a filterable**\n**table**\n**(needtable)**\n<size:10>FE_SPHINX_NEEDS_DIRECTIVE_NEEDTABLE</size>" as FE_SPHINX_NEEDS_DIRECTIVE_NEEDTABLE [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_DIRECTIVE_NEEDTABLE]] #Gold
rectangle "<size:12>Feature</size>\n**Render a**\n**PlantUML flow**\n**diagram of**\n**needs**\n**(needflow)**\n<size:10>FE_SPHINX_NEEDS_DIRECTIVE_NEEDFLOW</size>" as FE_SPHINX_NEEDS_DIRECTIVE_NEEDFLOW [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_DIRECTIVE_NEEDFLOW]] #Gold
rectangle "<size:12>Feature</size>\n**Create a pie**\n**chart based on**\n**need statistics**\n**(needpie)**\n<size:10>FE_SPHINX_NEEDS_DIRECTIVE_NEEDPIE</size>" as FE_SPHINX_NEEDS_DIRECTIVE_NEEDPIE [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_DIRECTIVE_NEEDPIE]] #Gold
rectangle "<size:12>Feature</size>\n**Create a bar**\n**chart based on**\n**need statistics**\n**(needbar)**\n<size:10>FE_SPHINX_NEEDS_DIRECTIVE_NEEDBAR</size>" as FE_SPHINX_NEEDS_DIRECTIVE_NEEDBAR [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_DIRECTIVE_NEEDBAR]] #Gold
rectangle "<size:12>Feature</size>\n**Import needs**\n**from an**\n**external JSON**\n**file**\n**(needimport)**\n<size:10>FE_SPHINX_NEEDS_DIRECTIVE_NEEDIMPORT</size>" as FE_SPHINX_NEEDS_DIRECTIVE_NEEDIMPORT [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_DIRECTIVE_NEEDIMPORT]] #Gold
rectangle "<size:12>Feature</size>\n**Modify existing**\n**needs in bulk**\n**(needextend)**\n<size:10>FE_SPHINX_NEEDS_DIRECTIVE_NEEDEXTEND</size>" as FE_SPHINX_NEEDS_DIRECTIVE_NEEDEXTEND [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_DIRECTIVE_NEEDEXTEND]] #Gold
rectangle "<size:12>Feature</size>\n**Direct linking**\n**between needs**\n**using IDs**\n<size:10>FE_SPHINX_NEEDS_LINKING_DIRECT</size>" as FE_SPHINX_NEEDS_LINKING_DIRECT [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_LINKING_DIRECT]] #Gold
rectangle "<size:12>Feature</size>\n**Bidirectional**\n**link tracking**\n<size:10>FE_SPHINX_NEEDS_LINKING_BIDIRECTIONAL</size>" as FE_SPHINX_NEEDS_LINKING_BIDIRECTIONAL [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_LINKING_BIDIRECTIONAL]] #Gold
rectangle "<size:12>Feature</size>\n**Dead link**\n**detection and**\n**warnings**\n<size:10>FE_SPHINX_NEEDS_LINKING_DEAD_LINK_DETECTION</size>" as FE_SPHINX_NEEDS_LINKING_DEAD_LINK_DETECTION [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_LINKING_DEAD_LINK_DETECTION]] #Gold
rectangle "<size:12>Feature</size>\n**Constraint**\n**checking to**\n**validate need**\n**relationships**\n<size:10>FE_SPHINX_NEEDS_DYNAMIC_CONSTRAINTS</size>" as FE_SPHINX_NEEDS_DYNAMIC_CONSTRAINTS [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_DYNAMIC_CONSTRAINTS]] #Gold
rectangle "<size:12>Feature</size>\n**Configuration**\n**via conf.py or**\n**an external**\n**TOML file**\n<size:10>FE_SPHINX_NEEDS_CONFIG_FILES</size>" as FE_SPHINX_NEEDS_CONFIG_FILES [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_CONFIG_FILES]] #Gold
rectangle "<size:12>Feature</size>\n**Customizable**\n**layouts for**\n**need**\n**presentation**\n<size:10>FE_SPHINX_NEEDS_CONFIG_LAYOUTS</size>" as FE_SPHINX_NEEDS_CONFIG_LAYOUTS [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_CONFIG_LAYOUTS]] #Gold
rectangle "<size:12>Feature</size>\n**JSON builder to**\n**export all need**\n**data**\n<size:10>FE_SPHINX_NEEDS_EXPORT_JSON</size>" as FE_SPHINX_NEEDS_EXPORT_JSON [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_EXPORT_JSON]] #Gold
rectangle "<size:12>Feature</size>\n**Permalink**\n**generation to**\n**specific need**\n**objects**\n<size:10>FE_SPHINX_NEEDS_EXPORT_PERMALINKS</size>" as FE_SPHINX_NEEDS_EXPORT_PERMALINKS [[../tools/sphinx-needs/features.html#FE_SPHINX_NEEDS_EXPORT_PERMALINKS]] #Gold
node "<size:12>Tool</size>\n**Sphinx-Needs**\n<size:10>TOOL_SN</size>" as TOOL_SN [[../tools/sphinx-needs/index.html#TOOL_SN]] #0fbcf9
rectangle "<size:12>Restriction</size>\n**Do not use**\n**dynamic**\n**functions**\n<size:10>CHECK_SN_NO_DYN</size>" as CHECK_SN_NO_DYN [[../tools/sphinx-needs/restrictions.html#CHECK_SN_NO_DYN]] #Orange
rectangle "<size:12>Restriction</size>\n**Warning to**\n**Error**\n<size:10>RE_SN_WARNINGS</size>" as RE_SN_WARNINGS [[../tools/sphinx-needs/restrictions.html#RE_SN_WARNINGS]] #Orange
rectangle "<size:12>Restriction</size>\n**Clean full**\n**build**\n<size:10>RE_SN_CLEAN</size>" as RE_SN_CLEAN [[../tools/sphinx-needs/restrictions.html#RE_SN_CLEAN]] #Orange
node "<size:12>Tool</size>\n**Sphinx-Test-**\n**Reports**\n<size:10>TOOL_STR</size>" as TOOL_STR [[../tools/sphinx-test-reports.html#TOOL_STR]] #0fbcf9
file "<size:12>Artifact</size>\n**rst file**\n<size:10>ART_SPHINX_RST</size>" as ART_SPHINX_RST [[../tools/sphinx/artifacts.html#ART_SPHINX_RST]] #LightBlue
rectangle "<size:12>Feature</size>\n**Read-in**\n**documents with**\n**Sphinx**\n<size:10>FE_SPHINX_READ</size>" as FE_SPHINX_READ [[../tools/sphinx/features.html#FE_SPHINX_READ]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Needed**\n**folders/files**\n**are ignored**\n<size:10>ER_FILES_IGNORED</size>" as ER_FILES_IGNORED [[../tools/sphinx/features.html#ER_FILES_IGNORED]] #Pink
rectangle "<size:12>Error</size>\n**Needed**\n**files/folders**\n**have not**\n**supported**\n**encoding**\n<size:10>ER_SPH_WRONG_ENCODING</size>" as ER_SPH_WRONG_ENCODING [[../tools/sphinx/features.html#ER_SPH_WRONG_ENCODING]] #Pink
rectangle "<size:12>Error</size>\n**Access to**\n**files/folders**\n**not given**\n<size:10>ER_SPH_WRONG_ACCESS</size>" as ER_SPH_WRONG_ACCESS [[../tools/sphinx/features.html#ER_SPH_WRONG_ACCESS]] #Pink
}
rectangle "<size:12>Feature</size>\n**Italicized**\n**(Emphasis) Text**\n<size:10>FE_SPHINX_INLINE_EMPHASIS</size>" as FE_SPHINX_INLINE_EMPHASIS [[../tools/sphinx/features.html#FE_SPHINX_INLINE_EMPHASIS]] #Gold
rectangle "<size:12>Feature</size>\n**Bold (Strong)**\n**Text**\n<size:10>FE_SPHINX_INLINE_STRONG</size>" as FE_SPHINX_INLINE_STRONG [[../tools/sphinx/features.html#FE_SPHINX_INLINE_STRONG]] #Gold
rectangle "<size:12>Feature</size>\n**Inline Literal**\n**(Code) Text**\n<size:10>FE_SPHINX_INLINE_LITERAL</size>" as FE_SPHINX_INLINE_LITERAL [[../tools/sphinx/features.html#FE_SPHINX_INLINE_LITERAL]] #Gold
rectangle "<size:12>Feature</size>\n**Named Hyperlink**\n**Reference**\n<size:10>FE_SPHINX_INLINE_NAMED_HYPERLINK</size>" as FE_SPHINX_INLINE_NAMED_HYPERLINK [[../tools/sphinx/features.html#FE_SPHINX_INLINE_NAMED_HYPERLINK]] #Gold
rectangle "<size:12>Feature</size>\n**Inline Internal**\n**Target**\n<size:10>FE_SPHINX_INLINE_INTERNAL_TARGET</size>" as FE_SPHINX_INLINE_INTERNAL_TARGET [[../tools/sphinx/features.html#FE_SPHINX_INLINE_INTERNAL_TARGET]] #Gold
rectangle "<size:12>Feature</size>\n**Escaped Markup**\n**Characters**\n<size:10>FE_SPHINX_INLINE_ESCAPE</size>" as FE_SPHINX_INLINE_ESCAPE [[../tools/sphinx/features.html#FE_SPHINX_INLINE_ESCAPE]] #Gold
rectangle "<size:12>Feature</size>\n**Subscript Role**\n<size:10>FE_SPHINX_ROLE_SUBSCRIPT</size>" as FE_SPHINX_ROLE_SUBSCRIPT [[../tools/sphinx/features.html#FE_SPHINX_ROLE_SUBSCRIPT]] #Gold
rectangle "<size:12>Feature</size>\n**Superscript**\n**Role**\n<size:10>FE_SPHINX_ROLE_SUPERSCRIPT</size>" as FE_SPHINX_ROLE_SUPERSCRIPT [[../tools/sphinx/features.html#FE_SPHINX_ROLE_SUPERSCRIPT]] #Gold
rectangle "<size:12>Feature</size>\n**Strong Role**\n<size:10>FE_SPHINX_ROLE_STRONG</size>" as FE_SPHINX_ROLE_STRONG [[../tools/sphinx/features.html#FE_SPHINX_ROLE_STRONG]] #Gold
rectangle "<size:12>Feature</size>\n**Emphasis Role**\n<size:10>FE_SPHINX_ROLE_EMPHASIS</size>" as FE_SPHINX_ROLE_EMPHASIS [[../tools/sphinx/features.html#FE_SPHINX_ROLE_EMPHASIS]] #Gold
rectangle "<size:12>Feature</size>\n**Literal Role**\n<size:10>FE_SPHINX_ROLE_LITERAL</size>" as FE_SPHINX_ROLE_LITERAL [[../tools/sphinx/features.html#FE_SPHINX_ROLE_LITERAL]] #Gold
rectangle "<size:12>Feature</size>\n**Code Role**\n<size:10>FE_SPHINX_ROLE_CODE</size>" as FE_SPHINX_ROLE_CODE [[../tools/sphinx/features.html#FE_SPHINX_ROLE_CODE]] #Gold
rectangle "<size:12>Feature</size>\n**Inline Math**\n**Role**\n<size:10>FE_SPHINX_ROLE_MATH</size>" as FE_SPHINX_ROLE_MATH [[../tools/sphinx/features.html#FE_SPHINX_ROLE_MATH]] #Gold
rectangle "<size:12>Feature</size>\n**Section Titles**\n**with Underlines**\n<size:10>FE_SPHINX_STRUCTURE_SECTION_TITLES</size>" as FE_SPHINX_STRUCTURE_SECTION_TITLES [[../tools/sphinx/features.html#FE_SPHINX_STRUCTURE_SECTION_TITLES]] #Gold
rectangle "<size:12>Feature</size>\n**Document Title**\n**and Subtitle**\n<size:10>FE_SPHINX_STRUCTURE_DOC_TITLE</size>" as FE_SPHINX_STRUCTURE_DOC_TITLE [[../tools/sphinx/features.html#FE_SPHINX_STRUCTURE_DOC_TITLE]] #Gold
rectangle "<size:12>Feature</size>\n**Transitions**\n**(Horizontal**\n**Lines)**\n<size:10>FE_SPHINX_STRUCTURE_TRANSITIONS</size>" as FE_SPHINX_STRUCTURE_TRANSITIONS [[../tools/sphinx/features.html#FE_SPHINX_STRUCTURE_TRANSITIONS]] #Gold
rectangle "<size:12>Feature</size>\n**Table of**\n**Contents Tree**\n**Directive**\n**(toctree)**\n<size:10>FE_SPHINX_DIRECTIVE_TOCTREE</size>" as FE_SPHINX_DIRECTIVE_TOCTREE [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_TOCTREE]] #Gold
rectangle "<size:12>Feature</size>\n**Rubric**\n**Directive**\n<size:10>FE_SPHINX_DIRECTIVE_RUBRIC</size>" as FE_SPHINX_DIRECTIVE_RUBRIC [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_RUBRIC]] #Gold
rectangle "<size:12>Feature</size>\n**Bulleted Lists**\n<size:10>FE_SPHINX_LISTS_BULLETED</size>" as FE_SPHINX_LISTS_BULLETED [[../tools/sphinx/features.html#FE_SPHINX_LISTS_BULLETED]] #Gold
rectangle "<size:12>Feature</size>\n**Numbered**\n**(Enumerated)**\n**Lists**\n<size:10>FE_SPHINX_LISTS_ENUMERATED</size>" as FE_SPHINX_LISTS_ENUMERATED [[../tools/sphinx/features.html#FE_SPHINX_LISTS_ENUMERATED]] #Gold
rectangle "<size:12>Feature</size>\n**Auto-Numbered**\n**Lists**\n<size:10>FE_SPHINX_LISTS_AUTO_NUMBERED</size>" as FE_SPHINX_LISTS_AUTO_NUMBERED [[../tools/sphinx/features.html#FE_SPHINX_LISTS_AUTO_NUMBERED]] #Gold
rectangle "<size:12>Feature</size>\n**Nested Lists**\n<size:10>FE_SPHINX_LISTS_NESTED</size>" as FE_SPHINX_LISTS_NESTED [[../tools/sphinx/features.html#FE_SPHINX_LISTS_NESTED]] #Gold
rectangle "<size:12>Feature</size>\n**Definition**\n**Lists**\n<size:10>FE_SPHINX_LISTS_DEFINITION</size>" as FE_SPHINX_LISTS_DEFINITION [[../tools/sphinx/features.html#FE_SPHINX_LISTS_DEFINITION]] #Gold
rectangle "<size:12>Feature</size>\n**Option Lists**\n<size:10>FE_SPHINX_LISTS_OPTION</size>" as FE_SPHINX_LISTS_OPTION [[../tools/sphinx/features.html#FE_SPHINX_LISTS_OPTION]] #Gold
rectangle "<size:12>Feature</size>\n**Block Quotes**\n<size:10>FE_SPHINX_CONTENT_BLOCKQUOTES</size>" as FE_SPHINX_CONTENT_BLOCKQUOTES [[../tools/sphinx/features.html#FE_SPHINX_CONTENT_BLOCKQUOTES]] #Gold
rectangle "<size:12>Feature</size>\n**Line Blocks**\n<size:10>FE_SPHINX_CONTENT_LINE_BLOCKS</size>" as FE_SPHINX_CONTENT_LINE_BLOCKS [[../tools/sphinx/features.html#FE_SPHINX_CONTENT_LINE_BLOCKS]] #Gold
rectangle "<size:12>Feature</size>\n**Image Directive**\n<size:10>FE_SPHINX_DIRECTIVE_IMAGE</size>" as FE_SPHINX_DIRECTIVE_IMAGE [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_IMAGE]] #Gold
rectangle "<size:12>Feature</size>\n**Figure**\n**Directive**\n<size:10>FE_SPHINX_DIRECTIVE_FIGURE</size>" as FE_SPHINX_DIRECTIVE_FIGURE [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_FIGURE]] #Gold
rectangle "<size:12>Feature</size>\n**Table Directive**\n**with Title**\n<size:10>FE_SPHINX_DIRECTIVE_TABLE</size>" as FE_SPHINX_DIRECTIVE_TABLE [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_TABLE]] #Gold
rectangle "<size:12>Feature</size>\n**Simple Tables**\n<size:10>FE_SPHINX_TABLES_SIMPLE</size>" as FE_SPHINX_TABLES_SIMPLE [[../tools/sphinx/features.html#FE_SPHINX_TABLES_SIMPLE]] #Gold
rectangle "<size:12>Feature</size>\n**Grid Tables**\n<size:10>FE_SPHINX_TABLES_GRID</size>" as FE_SPHINX_TABLES_GRID [[../tools/sphinx/features.html#FE_SPHINX_TABLES_GRID]] #Gold
rectangle "<size:12>Feature</size>\n**CSV Table**\n**Directive**\n<size:10>FE_SPHINX_DIRECTIVE_CSV_TABLE</size>" as FE_SPHINX_DIRECTIVE_CSV_TABLE [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_CSV_TABLE]] #Gold
rectangle "<size:12>Feature</size>\n**List Table**\n**Directive**\n<size:10>FE_SPHINX_DIRECTIVE_LIST_TABLE</size>" as FE_SPHINX_DIRECTIVE_LIST_TABLE [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_LIST_TABLE]] #Gold
rectangle "<size:12>Feature</size>\n**Code Block**\n**Directive**\n<size:10>FE_SPHINX_DIRECTIVE_CODE_BLOCK</size>" as FE_SPHINX_DIRECTIVE_CODE_BLOCK [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_CODE_BLOCK]] #Gold
rectangle "<size:12>Feature</size>\n**Literal Include**\n**Directive**\n<size:10>FE_SPHINX_DIRECTIVE_LITERALINCLUDE</size>" as FE_SPHINX_DIRECTIVE_LITERALINCLUDE [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_LITERALINCLUDE]] #Gold
rectangle "<size:12>Feature</size>\n**Math Directive**\n<size:10>FE_SPHINX_DIRECTIVE_MATH</size>" as FE_SPHINX_DIRECTIVE_MATH [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_MATH]] #Gold
rectangle "<size:12>Feature</size>\n**Contents**\n**Directive**\n**(Local ToC)**\n<size:10>FE_SPHINX_DIRECTIVE_CONTENTS</size>" as FE_SPHINX_DIRECTIVE_CONTENTS [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_CONTENTS]] #Gold
rectangle "<size:12>Feature</size>\n**Include**\n**Directive**\n<size:10>FE_SPHINX_DIRECTIVE_INCLUDE</size>" as FE_SPHINX_DIRECTIVE_INCLUDE [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_INCLUDE]] #Gold
rectangle "<size:12>Feature</size>\n**Raw Content**\n**Directive**\n<size:10>FE_SPHINX_DIRECTIVE_RAW</size>" as FE_SPHINX_DIRECTIVE_RAW [[../tools/sphinx/features.html#FE_SPHINX_DIRECTIVE_RAW]] #Gold
rectangle "<size:12>Feature</size>\n**Note Admonition**\n<size:10>FE_SPHINX_ADMONITION_NOTE</size>" as FE_SPHINX_ADMONITION_NOTE [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_NOTE]] #Gold
rectangle "<size:12>Feature</size>\n**Warning**\n**Admonition**\n<size:10>FE_SPHINX_ADMONITION_WARNING</size>" as FE_SPHINX_ADMONITION_WARNING [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_WARNING]] #Gold
rectangle "<size:12>Feature</size>\n**Hint Admonition**\n<size:10>FE_SPHINX_ADMONITION_HINT</size>" as FE_SPHINX_ADMONITION_HINT [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_HINT]] #Gold
rectangle "<size:12>Feature</size>\n**Tip Admonition**\n<size:10>FE_SPHINX_ADMONITION_TIP</size>" as FE_SPHINX_ADMONITION_TIP [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_TIP]] #Gold
rectangle "<size:12>Feature</size>\n**Important**\n**Admonition**\n<size:10>FE_SPHINX_ADMONITION_IMPORTANT</size>" as FE_SPHINX_ADMONITION_IMPORTANT [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_IMPORTANT]] #Gold
rectangle "<size:12>Feature</size>\n**Attention**\n**Admonition**\n<size:10>FE_SPHINX_ADMONITION_ATTENTION</size>" as FE_SPHINX_ADMONITION_ATTENTION [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_ATTENTION]] #Gold
rectangle "<size:12>Feature</size>\n**Caution**\n**Admonition**\n<size:10>FE_SPHINX_ADMONITION_CAUTION</size>" as FE_SPHINX_ADMONITION_CAUTION [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_CAUTION]] #Gold
rectangle "<size:12>Feature</size>\n**Error**\n**Admonition**\n<size:10>FE_SPHINX_ADMONITION_ERROR</size>" as FE_SPHINX_ADMONITION_ERROR [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_ERROR]] #Gold
rectangle "<size:12>Feature</size>\n**Danger**\n**Admonition**\n<size:10>FE_SPHINX_ADMONITION_DANGER</size>" as FE_SPHINX_ADMONITION_DANGER [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_DANGER]] #Gold
rectangle "<size:12>Feature</size>\n**Generic**\n**Admonition**\n<size:10>FE_SPHINX_ADMONITION_GENERIC</size>" as FE_SPHINX_ADMONITION_GENERIC [[../tools/sphinx/features.html#FE_SPHINX_ADMONITION_GENERIC]] #Gold
rectangle "<size:12>Feature</size>\n**External**\n**Hyperlinks**\n<size:10>FE_SPHINX_LINK_EXTERNAL</size>" as FE_SPHINX_LINK_EXTERNAL [[../tools/sphinx/features.html#FE_SPHINX_LINK_EXTERNAL]] #Gold
rectangle "<size:12>Feature</size>\n**Implicit**\n**Hyperlinks from**\n**URLs**\n<size:10>FE_SPHINX_LINK_IMPLICIT</size>" as FE_SPHINX_LINK_IMPLICIT [[../tools/sphinx/features.html#FE_SPHINX_LINK_IMPLICIT]] #Gold
rectangle "<size:12>Feature</size>\n**Internal Cross-**\n**References to**\n**Labels**\n<size:10>FE_SPHINX_LINK_INTERNAL_LABELS</size>" as FE_SPHINX_LINK_INTERNAL_LABELS [[../tools/sphinx/features.html#FE_SPHINX_LINK_INTERNAL_LABELS]] #Gold
rectangle "<size:12>Feature</size>\n**Explicit Target**\n**Creation**\n<size:10>FE_SPHINX_LINK_EXPLICIT_TARGET</size>" as FE_SPHINX_LINK_EXPLICIT_TARGET [[../tools/sphinx/features.html#FE_SPHINX_LINK_EXPLICIT_TARGET]] #Gold
rectangle "<size:12>Feature</size>\n**Reference Role**\n<size:10>FE_SPHINX_ROLE_REF</size>" as FE_SPHINX_ROLE_REF [[../tools/sphinx/features.html#FE_SPHINX_ROLE_REF]] #Gold
rectangle "<size:12>Feature</size>\n**Document Role**\n<size:10>FE_SPHINX_ROLE_DOC</size>" as FE_SPHINX_ROLE_DOC [[../tools/sphinx/features.html#FE_SPHINX_ROLE_DOC]] #Gold
rectangle "<size:12>Feature</size>\n**Numbered**\n**Reference Role**\n<size:10>FE_SPHINX_ROLE_NUMREF</size>" as FE_SPHINX_ROLE_NUMREF [[../tools/sphinx/features.html#FE_SPHINX_ROLE_NUMREF]] #Gold
rectangle "<size:12>Feature</size>\n**Footnotes**\n<size:10>FE_SPHINX_LINK_FOOTNOTES</size>" as FE_SPHINX_LINK_FOOTNOTES [[../tools/sphinx/features.html#FE_SPHINX_LINK_FOOTNOTES]] #Gold
rectangle "<size:12>Feature</size>\n**Citations**\n<size:10>FE_SPHINX_LINK_CITATIONS</size>" as FE_SPHINX_LINK_CITATIONS [[../tools/sphinx/features.html#FE_SPHINX_LINK_CITATIONS]] #Gold
rectangle "<size:12>Feature</size>\n**HTML Output**\n<size:10>FE_SPHINX_OUTPUT_HTML</size>" as FE_SPHINX_OUTPUT_HTML [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_HTML]] #Gold
rectangle "<size:12>Feature</size>\n**Single-File**\n**HTML Output**\n<size:10>FE_SPHINX_OUTPUT_SINGLE_HTML</size>" as FE_SPHINX_OUTPUT_SINGLE_HTML [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_SINGLE_HTML]] #Gold
rectangle "<size:12>Feature</size>\n**Directory HTML**\n**Output**\n<size:10>FE_SPHINX_OUTPUT_DIR_HTML</size>" as FE_SPHINX_OUTPUT_DIR_HTML [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_DIR_HTML]] #Gold
rectangle "<size:12>Feature</size>\n**LaTeX Output**\n<size:10>FE_SPHINX_OUTPUT_LATEX</size>" as FE_SPHINX_OUTPUT_LATEX [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_LATEX]] #Gold
rectangle "<size:12>Feature</size>\n**ePub 3 Output**\n<size:10>FE_SPHINX_OUTPUT_EPUB</size>" as FE_SPHINX_OUTPUT_EPUB [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_EPUB]] #Gold
rectangle "<size:12>Feature</size>\n**Man Page Output**\n<size:10>FE_SPHINX_OUTPUT_MANPAGE</size>" as FE_SPHINX_OUTPUT_MANPAGE [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_MANPAGE]] #Gold
rectangle "<size:12>Feature</size>\n**Plain Text**\n**Output**\n<size:10>FE_SPHINX_OUTPUT_TEXT</size>" as FE_SPHINX_OUTPUT_TEXT [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_TEXT]] #Gold
rectangle "<size:12>Feature</size>\n**JSON Output**\n<size:10>FE_SPHINX_OUTPUT_JSON</size>" as FE_SPHINX_OUTPUT_JSON [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_JSON]] #Gold
rectangle "<size:12>Feature</size>\n**Gettext Message**\n**Catalog Output**\n<size:10>FE_SPHINX_OUTPUT_GETTEXT</size>" as FE_SPHINX_OUTPUT_GETTEXT [[../tools/sphinx/features.html#FE_SPHINX_OUTPUT_GETTEXT]] #Gold
rectangle "<size:12>Feature</size>\n**Built-in HTML**\n**Search**\n<size:10>FE_SPHINX_BUILD_HTML_SEARCH</size>" as FE_SPHINX_BUILD_HTML_SEARCH [[../tools/sphinx/features.html#FE_SPHINX_BUILD_HTML_SEARCH]] #Gold
rectangle "<size:12>Feature</size>\n**HTML Theming**\n**Support**\n<size:10>FE_SPHINX_BUILD_THEMING</size>" as FE_SPHINX_BUILD_THEMING [[../tools/sphinx/features.html#FE_SPHINX_BUILD_THEMING]] #Gold
rectangle "<size:12>Feature</size>\n**Static File**\n**Support**\n<size:10>FE_SPHINX_BUILD_STATIC_FILES</size>" as FE_SPHINX_BUILD_STATIC_FILES [[../tools/sphinx/features.html#FE_SPHINX_BUILD_STATIC_FILES]] #Gold
node "<size:12>Tool</size>\n**Sphinx**\n<size:10>TOOL_SPHINX</size>" as TOOL_SPHINX [[../tools/sphinx/index.html#TOOL_SPHINX]] #0fbcf9
rectangle "<size:12>Restriction</size>\n**Warning to**\n**Error**\n<size:10>RE_SPHINX_WARNINGS</size>" as RE_SPHINX_WARNINGS [[../tools/sphinx/restrictions.html#RE_SPHINX_WARNINGS]] #Orange
rectangle "<size:12>Restriction</size>\n**Clean full**\n**build**\n<size:10>RE_SPHINX_CLEAN</size>" as RE_SPHINX_CLEAN [[../tools/sphinx/restrictions.html#RE_SPHINX_CLEAN]] #Orange
file "<size:12>Artifact</size>\n**ubc needs.json**\n**file**\n<size:10>ART_UBC_NEEDS_JSON</size>" as ART_UBC_NEEDS_JSON [[../tools/ubc/artifacts.html#ART_UBC_NEEDS_JSON]] #LightBlue
rectangle "<size:12>Feature</size>\n**Check rst files**\n**for linting**\n**problems**\n<size:10>FE_UBC_LINTING</size>" as FE_UBC_LINTING [[../tools/ubc/features.html#FE_UBC_LINTING]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Not covered**\n**format**\n<size:10>ER_UBC_LINTING_NOT_COVERED</size>" as ER_UBC_LINTING_NOT_COVERED [[../tools/ubc/features.html#ER_UBC_LINTING_NOT_COVERED]] #Pink
}
rectangle "<size:12>Feature</size>\n**Format rst**\n**files**\n<size:10>FE_UBC_FORMAT</size>" as FE_UBC_FORMAT [[../tools/ubc/features.html#FE_UBC_FORMAT]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Format**\n**introduces**\n**errors**\n<size:10>ER_UBC_FORMAT_ERRORS</size>" as ER_UBC_FORMAT_ERRORS [[../tools/ubc/features.html#ER_UBC_FORMAT_ERRORS]] #Pink
}
rectangle "<size:12>Feature</size>\n**Clean internal**\n**caches**\n<size:10>FE_UBC_CACHE</size>" as FE_UBC_CACHE [[../tools/ubc/features.html#FE_UBC_CACHE]] #Gold
rectangle "<size:12>Feature</size>\n**Build**\n**needs.json**\n<size:10>FE_UBC_BUILD_JSON</size>" as FE_UBC_BUILD_JSON [[../tools/ubc/features.html#FE_UBC_BUILD_JSON]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Incomplete data**\n<size:10>ER_UBC_JSON_INCOMPLETE</size>" as ER_UBC_JSON_INCOMPLETE [[../tools/ubc/features.html#ER_UBC_JSON_INCOMPLETE]] #Pink
}
rectangle "<size:12>Feature</size>\n**Validate**\n**needs.json**\n<size:10>FE_UBC_VALIDATE_JSON</size>" as FE_UBC_VALIDATE_JSON [[../tools/ubc/features.html#FE_UBC_VALIDATE_JSON]] #Gold{
'child needs:
rectangle "<size:12>Error</size>\n**Unknown file**\n**format**\n<size:10>ER_UBC_VAL_FORMAT</size>" as ER_UBC_VAL_FORMAT [[../tools/ubc/features.html#ER_UBC_VAL_FORMAT]] #Pink
rectangle "<size:12>Error</size>\n**Incomplete**\n**Validation**\n<size:10>ER_UBC_VAL_INCOMPLETE</size>" as ER_UBC_VAL_INCOMPLETE [[../tools/ubc/features.html#ER_UBC_VAL_INCOMPLETE]] #Pink
}
node "<size:12>Tool</size>\n**ubc**\n<size:10>TOOL_UBC</size>" as TOOL_UBC [[../tools/ubc/index.html#TOOL_UBC]] #0fbcf9
rectangle "<size:12>Restriction</size>\n**Do not use**\n**dynamic**\n**functions**\n<size:10>CHECK_UBC_NO_DYN</size>" as CHECK_UBC_NO_DYN [[../tools/ubc/restrictions.html#CHECK_UBC_NO_DYN]] #Orange
rectangle "<size:12>Restriction</size>\n**Do not use**\n**list2needs**\n<size:10>CHECK_UBC_NO_LIST2NEEDS</size>" as CHECK_UBC_NO_LIST2NEEDS [[../tools/ubc/restrictions.html#CHECK_UBC_NO_LIST2NEEDS]] #Orange
rectangle "<size:12>Restriction</size>\n**Do not**\n**use/reference**\n**rst files**\n**outside the**\n**ubproject**\n**workspace/scope**\n<size:10>CHECK_UBC_RST_WORKSPACE</size>" as CHECK_UBC_RST_WORKSPACE [[../tools/ubc/restrictions.html#CHECK_UBC_RST_WORKSPACE]] #Orange
node "<size:12>Tool</size>\n**ubCode**\n<size:10>TOOL_UBCODE</size>" as TOOL_UBCODE [[../tools/ubcode.html#TOOL_UBCODE]] #0fbcf9
node "<size:12>Tool</size>\n**ubTrace**\n<size:10>TOOL_UTRACE</size>" as TOOL_UTRACE [[../tools/ubtrace.html#TOOL_UTRACE]] #0fbcf9
rectangle "<size:12>Use Case</size>\n**Document**\n**software**\n**requirements**\n<size:10>UC_SW_REQ</size>" as UC_SW_REQ [[../use_cases/index.html#UC_SW_REQ]] #Thistle
rectangle "<size:12>Use Case</size>\n**Document SW**\n**architecture**\n<size:10>UC_SW_ARCH</size>" as UC_SW_ARCH [[../use_cases/index.html#UC_SW_ARCH]] #Thistle
rectangle "<size:12>Use Case</size>\n**Document SW**\n**Detail Design**\n**(SW API)**\n<size:10>UC_SW_API</size>" as UC_SW_API [[../use_cases/index.html#UC_SW_API]] #Thistle
rectangle "<size:12>Use Case</size>\n**Document SW**\n**Unit test cases**\n<size:10>UC_UNIT_TEST</size>" as UC_UNIT_TEST [[../use_cases/index.html#UC_UNIT_TEST]] #Thistle
rectangle "<size:12>Use Case</size>\n**Document Test**\n**results of SW**\n**Unit tests**\n<size:10>UC_UNIT_TEST_RESULTS</size>" as UC_UNIT_TEST_RESULTS [[../use_cases/index.html#UC_UNIT_TEST_RESULTS]] #Thistle
rectangle "<size:12>Use Case</size>\n**Document**\n**software**\n**qualification**\n**tests and**\n**results**\n<size:10>UC_SW_QA</size>" as UC_SW_QA [[../use_cases/index.html#UC_SW_QA]] #Thistle
' Connection definition
FE_SN_READ -[#333333]-> TOOL_SN
FE_SN_CONTENT_RENDER -[#333333]-> TOOL_SN
FE_SN_SET_META -[#333333]-> TOOL_SN
FE_SN_LINK -[#333333]-> TOOL_SN
FE_SN_DOCTREE -[#333333]-> TOOL_SN
FE_SN_JSON -[#333333]-> TOOL_SN
FE_SN_DYN_FUNC -[#333333]-> TOOL_SN
FE_SN_TEMPLATE_PAGE -[#333333]-> TOOL_SN
FE_SN_TEMPLATE_NEED -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_DEFINABLE_TYPES -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_CUSTOMIZABLE_OPTIONS -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_CUSTOMIZABLE_LINKS -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_AUTO_ID -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_MANUAL_ID -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_STATUS_ENFORCEMENT -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_TAGGING -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_NEED_PARTS -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_UNIQUE_ID_ENFORCEMENT -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_DIRECTIVE_NEEDTABLE -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_DIRECTIVE_NEEDFLOW -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_DIRECTIVE_NEEDPIE -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_DIRECTIVE_NEEDBAR -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_DIRECTIVE_NEEDIMPORT -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_DIRECTIVE_NEEDEXTEND -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_LINKING_DIRECT -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_LINKING_BIDIRECTIONAL -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_LINKING_DEAD_LINK_DETECTION -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_DYNAMIC_CONSTRAINTS -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_CONFIG_FILES -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_CONFIG_LAYOUTS -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_EXPORT_JSON -[#333333]-> TOOL_SN
FE_SPHINX_NEEDS_EXPORT_PERMALINKS -[#333333]-> TOOL_SN
CHECK_SN_NO_DYN -[#FA8072]-> ER_SN_DYN_INVALID
CHECK_SN_NO_DYN -[#FA8072]-> ER_SN_DYN_WRONG
RE_SN_WARNINGS -[#FA8072]-> ER_FILES_IGNORED
RE_SN_WARNINGS -[#FA8072]-> ER_SN_DATA_INVALID
FE_SPHINX_READ -[#333333]-> TOOL_SPHINX
FE_SPHINX_INLINE_EMPHASIS -[#333333]-> TOOL_SPHINX
FE_SPHINX_INLINE_STRONG -[#333333]-> TOOL_SPHINX
FE_SPHINX_INLINE_LITERAL -[#333333]-> TOOL_SPHINX
FE_SPHINX_INLINE_NAMED_HYPERLINK -[#333333]-> TOOL_SPHINX
FE_SPHINX_INLINE_INTERNAL_TARGET -[#333333]-> TOOL_SPHINX
FE_SPHINX_INLINE_ESCAPE -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_SUBSCRIPT -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_SUPERSCRIPT -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_STRONG -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_EMPHASIS -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_LITERAL -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_CODE -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_MATH -[#333333]-> TOOL_SPHINX
FE_SPHINX_STRUCTURE_SECTION_TITLES -[#333333]-> TOOL_SPHINX
FE_SPHINX_STRUCTURE_DOC_TITLE -[#333333]-> TOOL_SPHINX
FE_SPHINX_STRUCTURE_TRANSITIONS -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_TOCTREE -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_RUBRIC -[#333333]-> TOOL_SPHINX
FE_SPHINX_LISTS_BULLETED -[#333333]-> TOOL_SPHINX
FE_SPHINX_LISTS_ENUMERATED -[#333333]-> TOOL_SPHINX
FE_SPHINX_LISTS_AUTO_NUMBERED -[#333333]-> TOOL_SPHINX
FE_SPHINX_LISTS_NESTED -[#333333]-> TOOL_SPHINX
FE_SPHINX_LISTS_DEFINITION -[#333333]-> TOOL_SPHINX
FE_SPHINX_LISTS_OPTION -[#333333]-> TOOL_SPHINX
FE_SPHINX_CONTENT_BLOCKQUOTES -[#333333]-> TOOL_SPHINX
FE_SPHINX_CONTENT_LINE_BLOCKS -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_IMAGE -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_FIGURE -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_TABLE -[#333333]-> TOOL_SPHINX
FE_SPHINX_TABLES_SIMPLE -[#333333]-> TOOL_SPHINX
FE_SPHINX_TABLES_GRID -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_CSV_TABLE -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_LIST_TABLE -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_CODE_BLOCK -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_LITERALINCLUDE -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_MATH -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_CONTENTS -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_INCLUDE -[#333333]-> TOOL_SPHINX
FE_SPHINX_DIRECTIVE_RAW -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_NOTE -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_WARNING -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_HINT -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_TIP -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_IMPORTANT -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_ATTENTION -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_CAUTION -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_ERROR -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_DANGER -[#333333]-> TOOL_SPHINX
FE_SPHINX_ADMONITION_GENERIC -[#333333]-> TOOL_SPHINX
FE_SPHINX_LINK_EXTERNAL -[#333333]-> TOOL_SPHINX
FE_SPHINX_LINK_IMPLICIT -[#333333]-> TOOL_SPHINX
FE_SPHINX_LINK_INTERNAL_LABELS -[#333333]-> TOOL_SPHINX
FE_SPHINX_LINK_EXPLICIT_TARGET -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_REF -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_DOC -[#333333]-> TOOL_SPHINX
FE_SPHINX_ROLE_NUMREF -[#333333]-> TOOL_SPHINX
FE_SPHINX_LINK_FOOTNOTES -[#333333]-> TOOL_SPHINX
FE_SPHINX_LINK_CITATIONS -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_HTML -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_SINGLE_HTML -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_DIR_HTML -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_LATEX -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_EPUB -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_MANPAGE -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_TEXT -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_JSON -[#333333]-> TOOL_SPHINX
FE_SPHINX_OUTPUT_GETTEXT -[#333333]-> TOOL_SPHINX
FE_SPHINX_BUILD_HTML_SEARCH -[#333333]-> TOOL_SPHINX
FE_SPHINX_BUILD_THEMING -[#333333]-> TOOL_SPHINX
FE_SPHINX_BUILD_STATIC_FILES -[#333333]-> TOOL_SPHINX
RE_SPHINX_WARNINGS -[#FA8072]-> ER_FILES_IGNORED
RE_SPHINX_WARNINGS -[#FA8072]-> ER_SPH_WRONG_ENCODING
RE_SPHINX_WARNINGS -[#FA8072]-> ER_SPH_WRONG_ACCESS
FE_UBC_LINTING <-[thickness=1,#00AA00]- ART_SPHINX_RST
FE_UBC_LINTING -[#333333]-> TOOL_UBC
FE_UBC_FORMAT -[#333333]-> TOOL_UBC
FE_UBC_CACHE -[#333333]-> TOOL_UBC
FE_UBC_BUILD_JSON <-[thickness=1,#00AA00]- ART_SPHINX_RST
FE_UBC_BUILD_JSON -[thickness=1,#0000AA]-> ART_UBC_NEEDS_JSON
FE_UBC_BUILD_JSON -[#333333]-> TOOL_UBC
FE_UBC_VALIDATE_JSON <-[thickness=1,#00AA00]- ART_UBC_NEEDS_JSON
FE_UBC_VALIDATE_JSON -[#333333]-> TOOL_UBC
CHECK_UBC_NO_DYN -[#FA8072]-> ER_UBC_JSON_INCOMPLETE
CHECK_UBC_NO_LIST2NEEDS -[#FA8072]-> ER_UBC_JSON_INCOMPLETE
CHECK_UBC_RST_WORKSPACE -[#FA8072]-> ER_UBC_JSON_INCOMPLETE
UC_SW_REQ -[#Gold]-> FE_SPHINX_READ
UC_SW_REQ -[#Gold]-> FE_SN_READ
UC_SW_REQ -[#Gold]-> FE_SN_CONTENT_RENDER
UC_SW_REQ -[#Gold]-> FE_SN_SET_META
UC_SW_REQ -[#Gold]-> FE_SN_LINK
UC_SW_REQ -[#333333]-> TOOL_SPHINX
UC_SW_REQ -[#333333]-> TOOL_SN
UC_SW_REQ -[#333333]-> TOOL_UBC
UC_SW_ARCH -[#333333]-> TOOL_SPHINX
UC_SW_ARCH -[#333333]-> TOOL_SN
UC_SW_API -[#333333]-> TOOL_SPHINX
UC_SW_API -[#333333]-> TOOL_SN
UC_UNIT_TEST -[#333333]-> TOOL_SPHINX
UC_UNIT_TEST -[#333333]-> TOOL_SN
UC_UNIT_TEST_RESULTS -[#333333]-> TOOL_SPHINX
UC_UNIT_TEST_RESULTS -[#333333]-> TOOL_SN
UC_SW_QA -[#333333]-> TOOL_SPHINX
UC_SW_QA -[#333333]-> TOOL_SN
@enduml](../_images/plantuml-8cf41838c15ae55c4c4f6b2c212e8beabc26ab9f.svg)
Piechart¶
By Tool¶
By Type¶
