Page 1 of 1

documentation files in .rst format

Posted: Wed Jan 29, 2020 6:07 am
by wevets
in the documentation directory of the esp-idf, most of the files are in some '.rst' format. I can open the files in most any editor/word processor/browser. But he files clearly have block diagrams and other material in some sort of markup format that nothing I've tried, and I've tried several, can decode into diagrams.
How should these files be read? What program can open these files and render the diagrams and other stuff in this markup language?

Here's a partial example:
The ESP32 Wi-Fi programming model is depicted as follows:

.. blockdiag::
:caption: Wi-Fi Programming Model
:align: center

blockdiag wifi-programming-model {

# global attributes
node_height = 60;
node_width = 100;
span_width = 100;
span_height = 60;
default_shape = roundedbox;
default_group_color = none;
Thanks.

Re: documentation files in .rst format

Posted: Wed Jan 29, 2020 9:38 am
by ESP_Sprite
Those files mostly get converted into documentation by Sphinx, which has blockdiag as a plugin. If you want to look at the result, you can just check out the online docs we have.

Re: documentation files in .rst format

Posted: Wed Jan 29, 2020 9:18 pm
by wevets
Thanks. I continued rooting around after I posted my question at the top and found the online docs.