mirror of
https://github.com/espressif/esp-rainmaker.git
synced 2026-01-14 09:18:56 +00:00
e64c968747
Cleaned up esp-idf cloning. Modularised compilation of examples (build jobs). Added docs build job. Added support for auto deploying to github.
Documentation Source Folder
This folder contains source files of ESP RainMaker API documentation.
The sources do not render well in GitHub and some information is not visible at all.
Use actual documentation generated within about 20 minutes on each commit:
Hosted Documentation
The above URL is for the master branch latest version.
Building Documentation
- Install
makeanddoxygenfor your platform (makemay already be installed as an ESP-IDF prerequisite). - Change to the docs directory and run
make html makewill probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-runmake htmlto build the docs.
For MSYS2 MINGW32 on Windows
If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:
pacman -S doxygen mingw-w64-i686-python2-pillow
Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.