1.3.3.8.1. blockdiag Directive - Block Diagram

• Requirements:

  • Install: sphinxcontrib-blockdiag via Python pip (Included in SPHINX_ENV_INSTALL, Sphinx Environment)

  • Add sphinxcontrib.blockdiag to Sphinx extentions in conf.py (Included in SPHINX_ENV_INSTALL, Sphinx Environment via defaults.py)

This is your .rst file code example to create a Block Diagram http://blockdiag.com/en/blockdiag/index.html:

Table 1.3 blockdiag Options

Option	Values
:align:	left, center or right
:scale:	0-100 percentage value
:caption:	text to label Figure
:name:	text to create hyperlink for sphinx (no spaces)
:desctable:	Adds description table as shown in example. (no spaces in labels)

.. blockdiag::
    :align: center
    :caption: Example - Block Diagram
    :name: triton_coe_test_blockdiag
    :scale: 100
    :desctable:

    blockdiag {
        Level-1 ->  Level-2 ->  Level-3;
                    Level-2 ->              Req-Verify;
                                Level-3 ->  Req-Verify;
        Level-1 [description = "Integration in Lab 9"];
        Level-2 [description = "Qualification in Lab 10 West"];
        Level-3 [description = "Certification in Triton System Center (TSC)"];
        Req-Verify [description = "Requirements Verification"];
    }

The previous code-block will generate this Block Diagram:

Figure 1.2 Example - Block Diagram

Name	Description
Level-1	Integration in Lab 9
Level-2	Qualification in Lab 10 West
Level-3	Certification in Triton System Center (TSC)
Req-Verify	Requirements Verification