mirror of https://github.com/espressif/esp-rainmaker.git synced 2026-01-14 21:59:00 +00:00

Files

Piyush Shah 31d4b375e3 esp_rmaker: Moved out some generic modules from esp_rainmaker component

The following are now part of a separate repo (and included as git submodule):
- MQTT glue layer
- Work Queue
- Utilities (reset, reboot, time sync, timezone, etc.)
- Factory Storage

Even CLI is now a part of a seperate repo, included here as a git submodule.

2021-02-03 15:30:55 +05:30

_static

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

c-api-reference

esp_rmaker: Moved out some generic modules from esp_rainmaker component

2021-02-03 15:30:55 +05:30

python-api-reference

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

conf.py

cli-provisioning: Fixed connectivity and import checks

2020-05-18 19:40:02 +05:30

Doxyfile

esp_rmaker: Moved out some generic modules from esp_rainmaker component

2021-02-03 15:30:55 +05:30

gen-dxd.py

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

index.rst

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

link-roles.py

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

local_util.py

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

make.bat

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

Makefile

Add cleanups and feature additions to CI

2020-04-27 15:27:58 +05:30

README.md

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

requirements.txt

esp_rainmaker: Add various required components, examples and CLI

2020-04-16 04:13:35 +05:30

README.md

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

Check here: https://docs.espressif.com/projects/esp-rainmaker/en/latest/

The above URL is for the master branch latest version.

Building Documentation

Install make and doxygen for your platform (make may already be installed as an ESP-IDF prerequisite).
Change to the docs directory and run make html
make will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-run make html to 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.