documentation files in .rst format

wevets
Posts: 102
Joined: Sat Mar 09, 2019 2:56 am

documentation files in .rst format

Postby wevets » Wed Jan 29, 2020 6:07 am

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.

ESP_Sprite
Posts: 3904
Joined: Thu Nov 26, 2015 4:08 am

Re: documentation files in .rst format

Postby ESP_Sprite » Wed Jan 29, 2020 9:38 am

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.

wevets
Posts: 102
Joined: Sat Mar 09, 2019 2:56 am

Re: documentation files in .rst format

Postby wevets » Wed Jan 29, 2020 9:18 pm

Thanks. I continued rooting around after I posted my question at the top and found the online docs.

Who is online

Users browsing this forum: No registered users and 2 guests