Sphinx

Tool: Sphinx TOOL_SPHINX
status: in_progress
style: blue_bar
version: 7.4.7, 8.2.3
part of: FE_SPHINX_READ, FE_SPHINX_INLINE_EMPHASIS, FE_SPHINX_INLINE_STRONG, FE_SPHINX_INLINE_LITERAL, FE_SPHINX_INLINE_NAMED_HYPERLINK, FE_SPHINX_INLINE_INTERNAL_TARGET, FE_SPHINX_INLINE_ESCAPE, FE_SPHINX_ROLE_SUBSCRIPT, FE_SPHINX_ROLE_SUPERSCRIPT, FE_SPHINX_ROLE_STRONG, FE_SPHINX_ROLE_EMPHASIS, FE_SPHINX_ROLE_LITERAL, FE_SPHINX_ROLE_CODE, FE_SPHINX_ROLE_MATH, FE_SPHINX_STRUCTURE_SECTION_TITLES, FE_SPHINX_STRUCTURE_DOC_TITLE, FE_SPHINX_STRUCTURE_TRANSITIONS, FE_SPHINX_DIRECTIVE_TOCTREE, FE_SPHINX_DIRECTIVE_RUBRIC, FE_SPHINX_LISTS_BULLETED, FE_SPHINX_LISTS_ENUMERATED, FE_SPHINX_LISTS_AUTO_NUMBERED, FE_SPHINX_LISTS_NESTED, FE_SPHINX_LISTS_DEFINITION, FE_SPHINX_LISTS_OPTION, FE_SPHINX_CONTENT_BLOCKQUOTES, FE_SPHINX_CONTENT_LINE_BLOCKS, FE_SPHINX_DIRECTIVE_IMAGE, FE_SPHINX_DIRECTIVE_FIGURE, FE_SPHINX_DIRECTIVE_TABLE, FE_SPHINX_TABLES_SIMPLE, FE_SPHINX_TABLES_GRID, FE_SPHINX_DIRECTIVE_CSV_TABLE, FE_SPHINX_DIRECTIVE_LIST_TABLE, FE_SPHINX_DIRECTIVE_CODE_BLOCK, FE_SPHINX_DIRECTIVE_LITERALINCLUDE, FE_SPHINX_DIRECTIVE_MATH, FE_SPHINX_DIRECTIVE_CONTENTS, FE_SPHINX_DIRECTIVE_INCLUDE, FE_SPHINX_DIRECTIVE_RAW, FE_SPHINX_ADMONITION_NOTE, FE_SPHINX_ADMONITION_WARNING, FE_SPHINX_ADMONITION_HINT, FE_SPHINX_ADMONITION_TIP, FE_SPHINX_ADMONITION_IMPORTANT, FE_SPHINX_ADMONITION_ATTENTION, FE_SPHINX_ADMONITION_CAUTION, FE_SPHINX_ADMONITION_ERROR, FE_SPHINX_ADMONITION_DANGER, FE_SPHINX_ADMONITION_GENERIC, FE_SPHINX_LINK_EXTERNAL, FE_SPHINX_LINK_IMPLICIT, FE_SPHINX_LINK_INTERNAL_LABELS, FE_SPHINX_LINK_EXPLICIT_TARGET, FE_SPHINX_ROLE_REF, FE_SPHINX_ROLE_DOC, FE_SPHINX_ROLE_NUMREF, FE_SPHINX_LINK_FOOTNOTES, FE_SPHINX_LINK_CITATIONS, FE_SPHINX_OUTPUT_HTML, FE_SPHINX_OUTPUT_SINGLE_HTML, FE_SPHINX_OUTPUT_DIR_HTML, FE_SPHINX_OUTPUT_LATEX, FE_SPHINX_OUTPUT_EPUB, FE_SPHINX_OUTPUT_MANPAGE, FE_SPHINX_OUTPUT_TEXT, FE_SPHINX_OUTPUT_JSON, FE_SPHINX_OUTPUT_GETTEXT, FE_SPHINX_BUILD_HTML_SEARCH, FE_SPHINX_BUILD_THEMING, FE_SPHINX_BUILD_STATIC_FILES, UC_SW_REQ, UC_SW_ARCH, UC_SW_API, UC_UNIT_TEST, UC_UNIT_TEST_RESULTS, UC_SW_QA

Sphinx makes it easy to create intelligent and beautiful documentation.

Documentation:

https://www.sphinx-doc.org/en/master/

Code:

https://github.com/sphinx-doc/sphinx

Analysis

@startuml ' Nodes definition 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>Fault</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>Fault</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>Fault</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>Fault</size>\n**Incremental**\n**build leaves**\n**stale or**\n**incomplete**\n**output**\n<size:10>ER_SPH_STALE_BUILD</size>" as ER_SPH_STALE_BUILD [[../tools/sphinx/features.html#ER_SPH_STALE_BUILD]] #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{ 'child needs: rectangle "<size:12>Fault</size>\n**Named hyperlink**\n**resolves to**\n**wrong or broken**\n**target**\n<size:10>ER_SPH_HYPERLINK_BROKEN</size>" as ER_SPH_HYPERLINK_BROKEN [[../tools/sphinx/features.html#ER_SPH_HYPERLINK_BROKEN]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Document is**\n**missing from**\n**the toctree**\n<size:10>ER_SPH_TOCTREE_MISSING</size>" as ER_SPH_TOCTREE_MISSING [[../tools/sphinx/features.html#ER_SPH_TOCTREE_MISSING]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Image is**\n**missing or not**\n**copied to the**\n**output**\n<size:10>ER_SPH_IMAGE_MISSING</size>" as ER_SPH_IMAGE_MISSING [[../tools/sphinx/features.html#ER_SPH_IMAGE_MISSING]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Figure caption**\n**or image is**\n**wrong or**\n**missing**\n<size:10>ER_SPH_FIGURE_WRONG</size>" as ER_SPH_FIGURE_WRONG [[../tools/sphinx/features.html#ER_SPH_FIGURE_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Table title or**\n**rows are**\n**rendered**\n**incorrectly**\n<size:10>ER_SPH_TABLE_WRONG</size>" as ER_SPH_TABLE_WRONG [[../tools/sphinx/features.html#ER_SPH_TABLE_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Simple table**\n**cells are**\n**misparsed**\n<size:10>ER_SPH_TABLE_SIMPLE_WRONG</size>" as ER_SPH_TABLE_SIMPLE_WRONG [[../tools/sphinx/features.html#ER_SPH_TABLE_SIMPLE_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Grid table**\n**spans are**\n**rendered**\n**incorrectly**\n<size:10>ER_SPH_TABLE_GRID_WRONG</size>" as ER_SPH_TABLE_GRID_WRONG [[../tools/sphinx/features.html#ER_SPH_TABLE_GRID_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**CSV table**\n**content is**\n**imported**\n**incorrectly**\n<size:10>ER_SPH_CSV_WRONG</size>" as ER_SPH_CSV_WRONG [[../tools/sphinx/features.html#ER_SPH_CSV_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**List table rows**\n**or columns are**\n**rendered**\n**incorrectly**\n<size:10>ER_SPH_LISTTABLE_WRONG</size>" as ER_SPH_LISTTABLE_WRONG [[../tools/sphinx/features.html#ER_SPH_LISTTABLE_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Wrong content**\n**or line range**\n**is included**\n<size:10>ER_SPH_LITINCLUDE_WRONG</size>" as ER_SPH_LITINCLUDE_WRONG [[../tools/sphinx/features.html#ER_SPH_LITINCLUDE_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Wrong or**\n**missing file is**\n**included**\n**silently**\n<size:10>ER_SPH_INCLUDE_WRONG</size>" as ER_SPH_INCLUDE_WRONG [[../tools/sphinx/features.html#ER_SPH_INCLUDE_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**HTML output is**\n**incomplete or**\n**incorrect**\n<size:10>ER_SPH_HTML_WRONG</size>" as ER_SPH_HTML_WRONG [[../tools/sphinx/features.html#ER_SPH_HTML_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Single-file**\n**HTML output is**\n**incomplete or**\n**incorrect**\n<size:10>ER_SPH_SINGLEHTML_WRONG</size>" as ER_SPH_SINGLEHTML_WRONG [[../tools/sphinx/features.html#ER_SPH_SINGLEHTML_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**Directory HTML**\n**output has a**\n**wrong structure**\n<size:10>ER_SPH_DIRHTML_WRONG</size>" as ER_SPH_DIRHTML_WRONG [[../tools/sphinx/features.html#ER_SPH_DIRHTML_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**LaTeX output is**\n**incomplete or**\n**incorrect**\n<size:10>ER_SPH_LATEX_WRONG</size>" as ER_SPH_LATEX_WRONG [[../tools/sphinx/features.html#ER_SPH_LATEX_WRONG]] #Pink } 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{ 'child needs: rectangle "<size:12>Fault</size>\n**ePub output is**\n**incomplete or**\n**invalid**\n<size:10>ER_SPH_EPUB_WRONG</size>" as ER_SPH_EPUB_WRONG [[../tools/sphinx/features.html#ER_SPH_EPUB_WRONG]] #Pink } 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 ' Connection definition 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 RE_SPHINX_CLEAN -[#FA8072]-> ER_SPH_STALE_BUILD @enduml

ID

Title

Type

ART_SPHINX_RST

rst file

artifact

ER_FILES_IGNORED

Needed folders/files are ignored

fault

ER_SPH_CSV_WRONG

CSV table content is imported incorrectly

fault

ER_SPH_DIRHTML_WRONG

Directory HTML output has a wrong structure

fault

ER_SPH_EPUB_WRONG

ePub output is incomplete or invalid

fault

ER_SPH_FIGURE_WRONG

Figure caption or image is wrong or missing

fault

ER_SPH_HTML_WRONG

HTML output is incomplete or incorrect

fault

ER_SPH_HYPERLINK_BROKEN

Named hyperlink resolves to wrong or broken target

fault

ER_SPH_IMAGE_MISSING

Image is missing or not copied to the output

fault

ER_SPH_INCLUDE_WRONG

Wrong or missing file is included silently

fault

ER_SPH_LATEX_WRONG

LaTeX output is incomplete or incorrect

fault

ER_SPH_LISTTABLE_WRONG

List table rows or columns are rendered incorrectly

fault

ER_SPH_LITINCLUDE_WRONG

Wrong content or line range is included

fault

ER_SPH_SINGLEHTML_WRONG

Single-file HTML output is incomplete or incorrect

fault

ER_SPH_STALE_BUILD

Incremental build leaves stale or incomplete output

fault

ER_SPH_TABLE_GRID_WRONG

Grid table spans are rendered incorrectly

fault

ER_SPH_TABLE_SIMPLE_WRONG

Simple table cells are misparsed

fault

ER_SPH_TABLE_WRONG

Table title or rows are rendered incorrectly

fault

ER_SPH_TOCTREE_MISSING

Document is missing from the toctree

fault

ER_SPH_WRONG_ACCESS

Access to files/folders not given

fault

ER_SPH_WRONG_ENCODING

Needed files/folders have not supported encoding

fault

FE_SPHINX_ADMONITION_ATTENTION

Attention Admonition

feature

FE_SPHINX_ADMONITION_CAUTION

Caution Admonition

feature

FE_SPHINX_ADMONITION_DANGER

Danger Admonition

feature

FE_SPHINX_ADMONITION_ERROR

Error Admonition

feature

FE_SPHINX_ADMONITION_GENERIC

Generic Admonition

feature

FE_SPHINX_ADMONITION_HINT

Hint Admonition

feature

FE_SPHINX_ADMONITION_IMPORTANT

Important Admonition

feature

FE_SPHINX_ADMONITION_NOTE

Note Admonition

feature

FE_SPHINX_ADMONITION_TIP

Tip Admonition

feature

FE_SPHINX_ADMONITION_WARNING

Warning Admonition

feature

FE_SPHINX_BUILD_HTML_SEARCH

Built-in HTML Search

feature

FE_SPHINX_BUILD_STATIC_FILES

Static File Support

feature

FE_SPHINX_BUILD_THEMING

HTML Theming Support

feature

FE_SPHINX_CONTENT_BLOCKQUOTES

Block Quotes

feature

FE_SPHINX_CONTENT_LINE_BLOCKS

Line Blocks

feature

FE_SPHINX_DIRECTIVE_CODE_BLOCK

Code Block Directive

feature

FE_SPHINX_DIRECTIVE_CONTENTS

Contents Directive (Local ToC)

feature

FE_SPHINX_DIRECTIVE_CSV_TABLE

CSV Table Directive

feature

FE_SPHINX_DIRECTIVE_FIGURE

Figure Directive

feature

FE_SPHINX_DIRECTIVE_IMAGE

Image Directive

feature

FE_SPHINX_DIRECTIVE_INCLUDE

Include Directive

feature

FE_SPHINX_DIRECTIVE_LIST_TABLE

List Table Directive

feature

FE_SPHINX_DIRECTIVE_LITERALINCLUDE

Literal Include Directive

feature

FE_SPHINX_DIRECTIVE_MATH

Math Directive

feature

FE_SPHINX_DIRECTIVE_RAW

Raw Content Directive

feature

FE_SPHINX_DIRECTIVE_RUBRIC

Rubric Directive

feature

FE_SPHINX_DIRECTIVE_TABLE

Table Directive with Title

feature

FE_SPHINX_DIRECTIVE_TOCTREE

Table of Contents Tree Directive (toctree)

feature

FE_SPHINX_INLINE_EMPHASIS

Italicized (Emphasis) Text

feature

FE_SPHINX_INLINE_ESCAPE

Escaped Markup Characters

feature

FE_SPHINX_INLINE_INTERNAL_TARGET

Inline Internal Target

feature

FE_SPHINX_INLINE_LITERAL

Inline Literal (Code) Text

feature

FE_SPHINX_INLINE_NAMED_HYPERLINK

Named Hyperlink Reference

feature

FE_SPHINX_INLINE_STRONG

Bold (Strong) Text

feature

FE_SPHINX_LINK_CITATIONS

Citations

feature

FE_SPHINX_LINK_EXPLICIT_TARGET

Explicit Target Creation

feature

FE_SPHINX_LINK_EXTERNAL

External Hyperlinks

feature

FE_SPHINX_LINK_FOOTNOTES

Footnotes

feature

FE_SPHINX_LINK_IMPLICIT

Implicit Hyperlinks from URLs

feature

FE_SPHINX_LINK_INTERNAL_LABELS

Internal Cross-References to Labels

feature

FE_SPHINX_LISTS_AUTO_NUMBERED

Auto-Numbered Lists

feature

FE_SPHINX_LISTS_BULLETED

Bulleted Lists

feature

FE_SPHINX_LISTS_DEFINITION

Definition Lists

feature

FE_SPHINX_LISTS_ENUMERATED

Numbered (Enumerated) Lists

feature

FE_SPHINX_LISTS_NESTED

Nested Lists

feature

FE_SPHINX_LISTS_OPTION

Option Lists

feature

FE_SPHINX_OUTPUT_DIR_HTML

Directory HTML Output

feature

FE_SPHINX_OUTPUT_EPUB

ePub 3 Output

feature

FE_SPHINX_OUTPUT_GETTEXT

Gettext Message Catalog Output

feature

FE_SPHINX_OUTPUT_HTML

HTML Output

feature

FE_SPHINX_OUTPUT_JSON

JSON Output

feature

FE_SPHINX_OUTPUT_LATEX

LaTeX Output

feature

FE_SPHINX_OUTPUT_MANPAGE

Man Page Output

feature

FE_SPHINX_OUTPUT_SINGLE_HTML

Single-File HTML Output

feature

FE_SPHINX_OUTPUT_TEXT

Plain Text Output

feature

FE_SPHINX_READ

Read-in documents with Sphinx

feature

FE_SPHINX_ROLE_CODE

Code Role

feature

FE_SPHINX_ROLE_DOC

Document Role

feature

FE_SPHINX_ROLE_EMPHASIS

Emphasis Role

feature

FE_SPHINX_ROLE_LITERAL

Literal Role

feature

FE_SPHINX_ROLE_MATH

Inline Math Role

feature

FE_SPHINX_ROLE_NUMREF

Numbered Reference Role

feature

FE_SPHINX_ROLE_REF

Reference Role

feature

FE_SPHINX_ROLE_STRONG

Strong Role

feature

FE_SPHINX_ROLE_SUBSCRIPT

Subscript Role

feature

FE_SPHINX_ROLE_SUPERSCRIPT

Superscript Role

feature

FE_SPHINX_STRUCTURE_DOC_TITLE

Document Title and Subtitle

feature

FE_SPHINX_STRUCTURE_SECTION_TITLES

Section Titles with Underlines

feature

FE_SPHINX_STRUCTURE_TRANSITIONS

Transitions (Horizontal Lines)

feature

FE_SPHINX_TABLES_GRID

Grid Tables

feature

FE_SPHINX_TABLES_SIMPLE

Simple Tables

feature

RE_SPHINX_CLEAN

Clean full build

restriction

RE_SPHINX_WARNINGS

Warning to Error

restriction

TOOL_SPHINX

Sphinx

tool
../../_images/need_pie_0d76b.svg
✅ Compliance statistics

Features with safety impact and without faults: 0 / 17

Faults without a mitigation: 16 / 20

Restrictions without fault: 0 / 2

Checks without fault: 0 / 0

Passed test executions: 0 / 0