Related Resources

reStructuredText Directives describes the directives that extend the reStructuredText (reST) syntax.
Sphinx covers the basics of getting started with Sphinx. On this site, reStructuredText Primer section introduces reST concepts and syntax.
API Documentation Template provides a template in rst format to document API.
To see the rendered output of directives and functionality that ESP-Docs supports, refer to the documentation built with ESP-Docs, such as
To learn more about how documentation builds, go to
- Docutils that explains how this text processing system processes plaintext documentation into formats like HTML
- Doxygen that explains how the standard tool generates documentation from annotated C++ sources
To try Markdown in your documentation, Recommonmark parser’s documentation page presents an approach to write CommonMark inside of Sphinx projects.
An overview of ESP-Docs is given in the ESP DevCon22 talk How to create awesome documentation for your ESP32-X using ESP-Docs. The video starts at 2:32:21.
Espressif Manual of Style answers some writing style questions.
To seek help from the Documentation Team, please check Documentation Team Site. Type the keywords in the search box, and all relevant ready-made documents will show up.