ESP-Docs User Guide
ESP-Docs is a documentation-building system developed by Espressif based on Sphinx and Read the Docs. This guide provides information on how to use it as the documentation-building system in a project and how to write, build, configure, and deploy the documentation under this system.
It is primarily for developers, writers, and translators who work on Espressif software documentation. Others can also use it as a reference, such as for reStructuredText syntax, Sphinx extensions, and customizing your documentation-building system based on Sphinx. Note that some links in this guide point to Espressif’s internal documentation, which is thus not accessible to external users.
The guide consists of the following major sections:
|
Overview, features, extensions, supported markup language of ESP-Docs. |
|
ESP-Docs-specific syntax and generic Sphinx and restructuredText syntax, including basic syntax and link syntax. |
|
How to preview documentation, build documentation from source to target (HTML, PDF) etc. |
|
Configuration to Git projects to use ESP-Docs, adding extensions, etc. |
