Initial commit.

docs/en/c-api-reference/index.rst

@@ -0,0 +1,12 @@
+C API Reference
+================
+
+.. toctree::
+   :maxdepth: 4
+
+   rainmaker_core.rst
+   rainmaker_standard_types.rst
+   rainmaker_mqtt.rst
+   rainmaker_ota.rst
+   rainmaker_console.rst
+   rainmaker_common.rst

docs/en/c-api-reference/rainmaker_common.rst

@@ -0,0 +1,18 @@
+RainMaker Common
+################
+
+Utilities
+---------
+.. include-build-file:: inc/esp_rmaker_utils.inc
+
+Factory Storage
+---------------
+.. include-build-file:: inc/esp_rmaker_factory.inc
+
+Work Queue
+----------
+.. include-build-file:: inc/esp_rmaker_work_queue.inc
+
+Common Events
+-------------
+.. include-build-file:: inc/esp_rmaker_common_events.inc

docs/en/c-api-reference/rainmaker_console.rst

@@ -0,0 +1,3 @@
+RainMaker Console
+#################
+.. include-build-file:: inc/esp_rmaker_console.inc

docs/en/c-api-reference/rainmaker_core.rst

@@ -0,0 +1,18 @@
+RainMaker Core
+##############
+
+Core
+----
+.. include-build-file:: inc/esp_rmaker_core.inc
+
+User Mapping
+------------
+.. include-build-file:: inc/esp_rmaker_user_mapping.inc
+
+Scheduling
+----------
+.. include-build-file:: inc/esp_rmaker_schedule.inc
+
+Scenes
+------
+.. include-build-file:: inc/esp_rmaker_scenes.inc

docs/en/c-api-reference/rainmaker_mqtt.rst

@@ -0,0 +1,3 @@
+RainMaker MQTT
+##############
+.. include-build-file:: inc/esp_rmaker_mqtt.inc

docs/en/c-api-reference/rainmaker_ota.rst

@@ -0,0 +1,3 @@
+RainMaker OTA
+#############
+.. include-build-file:: inc/esp_rmaker_ota.inc

docs/en/c-api-reference/rainmaker_standard_types.rst

@@ -0,0 +1,18 @@
+RainMaker Standard Types
+########################
+
+Standard Types
+--------------
+.. include-build-file:: inc/esp_rmaker_standard_types.inc
+
+Standard Parameters
+-------------------
+.. include-build-file:: inc/esp_rmaker_standard_params.inc
+
+Standard Devices
+----------------
+.. include-build-file:: inc/esp_rmaker_standard_devices.inc
+
+Standard Services
+-----------------
+.. include-build-file:: inc/esp_rmaker_standard_services.inc

docs/en/conf.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+#
+# English Language RTD & Sphinx config file
+#
+# Uses ../conf_common.py for most non-language-specific settings.
+
+# Importing conf_common adds all the non-language-specific
+# parts to this conf module
+try:
+    from conf_common import *  # noqa: F403,F401
+except ImportError:
+    import os
+    import sys
+    sys.path.insert(0, os.path.abspath('../'))
+    from conf_common import *  # noqa: F403,F401
+
+import datetime
+
+sys.path.append(os.path.abspath('../../cli/'))
+autodoc_mock_imports = ["pathlib", "cryptography", "nvs_partition_gen", "oauth2client", "serial", "user_mapping", "rmaker_tools.rmaker_prov.esp_rainmaker_prov", "rmaker_tools.rmaker_prov.security", "rmaker_tools.rmaker_prov.prov", "rmaker_tools.rmaker_prov.prov_util", "rmaker_tools.rmaker_claim.claim"]
+
+current_year = datetime.datetime.now().year
+# -- Project information -----------------------------------------------------
+
+project = u'ESP RainMaker Programming Guide'
+copyright = u'2020, Espressif Systems (Shanghai) CO., LTD'
+author = 'Espressif'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+language = 'en'

docs/en/index.rst

@@ -0,0 +1,12 @@
+ESP RainMaker Programming Guide
+===============================
+ESP RainMaker is an end-to-end solution offered by Espressif to enable remote control and monitoring for products based on ESP32 series of SoCs (e.g., ESP32, ESP32-S2, ESP32-C3, ESP32-C6, ESP32-C2, etc.) without any configuration required in the Cloud. It provides a device SDK, self-adapting phone apps, transparent cloud middleware and host utilities to reduce complexity in development of connected devices.
+
+This is the C API (for firmware) and Python API (for host tools) documentation for ESP RainMaker. All other documentation can be found at `http://rainmaker.espressif.com <http://rainmaker.espressif.com>`_
+
+.. _C API Reference: c-api-reference/index.html
+
+.. toctree::
+   :hidden:
+
+   c-api-reference/index