Sphinx¶
Sphinx makes it easy to create intelligent and beautiful documentation.
|
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>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
' 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
@enduml](../../_images/plantuml-ff4e3088d33ab81ab156eb24e429ae9100815340.svg)
ID |
Title |
Type |
|---|---|---|
rst file |
artifact |
|
Needed folders/files are ignored |
error |
|
Access to files/folders not given |
error |
|
Needed files/folders have not supported encoding |
error |
|
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 |
|
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 |
|
Clean full build |
restriction |
|
Warning to Error |
restriction |
|
Sphinx |
tool |
✅ Compliance statistics
Features without errors: 70 / 71
Errors without a mitigation: 0 / 3
Restrictions without error: 0 / 2
Checks without error: 0 / 0