pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add new top-level docs builder that builds docs for a single chip

Browse Source
This commit is contained in:
Angus Gratton
2019-11-13 11:46:16 +08:00
committed by Angus Gratton
parent 783856d557
commit e6211c7864
133 changed files with 566 additions and 637 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/bluetooth/controller_vhci.rst
+1 -1
View File
@@ -18,4 +18,4 @@ Check :example:`bluetooth/bluedroid/hci` folder in ESP-IDF examples, which conta
API Reference
-------------
.. include:: /_build/inc/esp_bt.inc
.. include-build-file:: inc/esp_bt.inc
docs/en/api-reference/bluetooth/esp-ble-mesh.rst
+13 -13
View File
@@ -42,7 +42,7 @@ This section contains only one header file, which lists the following items of E
* Structs used to transmit/receive messages
* Event types and related event parameters
.. include:: /_build/inc/esp_ble_mesh_defs.inc
.. include-build-file:: inc/esp_ble_mesh_defs.inc
ESP-BLE-MESH Core API Reference
@@ -64,37 +64,37 @@ This API reference covers six components:
ESP-BLE-MESH Stack Initialization
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_common_api.inc
.. include-build-file:: inc/esp_ble_mesh_common_api.inc
Reading of Local Data Information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_local_data_operation_api.inc
.. include-build-file:: inc/esp_ble_mesh_local_data_operation_api.inc
Low Power Operation (Updating)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_low_power_api.inc
.. include-build-file:: inc/esp_ble_mesh_low_power_api.inc
Send/Publish Messages, add Local AppKey, etc.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_networking_api.inc
.. include-build-file:: inc/esp_ble_mesh_networking_api.inc
ESP-BLE-MESH Node/Provisioner Provisioning
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_provisioning_api.inc
.. include-build-file:: inc/esp_ble_mesh_provisioning_api.inc
ESP-BLE-MESH GATT Proxy Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_proxy_api.inc
.. include-build-file:: inc/esp_ble_mesh_proxy_api.inc
ESP-BLE-MESH Models API Reference
@@ -120,35 +120,35 @@ There are six categories of models:
Configuration Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_config_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_config_model_api.inc
Health Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_generic_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_generic_model_api.inc
Generic Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_health_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_health_model_api.inc
Sensor Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_lighting_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_lighting_model_api.inc
Time and Scenes Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_sensor_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_sensor_model_api.inc
Lighting Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include:: /_build/inc/esp_ble_mesh_time_scene_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_time_scene_model_api.inc
docs/en/api-reference/bluetooth/esp_a2dp.rst
+1 -1
View File
@@ -18,5 +18,5 @@ Check :example:`bluetooth/bluedroid/classic_bt` folder in ESP-IDF examples, whic
API Reference
-------------
.. include:: /_build/inc/esp_a2dp_api.inc
.. include-build-file:: inc/esp_a2dp_api.inc
docs/en/api-reference/bluetooth/esp_avrc.rst
+1 -1
View File
@@ -18,6 +18,6 @@ Application Example
API Reference
-------------
.. include:: /_build/inc/esp_avrc_api.inc
.. include-build-file:: inc/esp_avrc_api.inc
docs/en/api-reference/bluetooth/esp_blufi.rst
+1 -1
View File
@@ -19,5 +19,5 @@ Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which conta
API Reference
-------------
.. include:: /_build/inc/esp_blufi_api.inc
.. include-build-file:: inc/esp_blufi_api.inc
docs/en/api-reference/bluetooth/esp_bt_defs.rst
+1 -1
View File
@@ -17,5 +17,5 @@ Application Example
API Reference
-------------
.. include:: /_build/inc/esp_bt_defs.inc
.. include-build-file:: inc/esp_bt_defs.inc
docs/en/api-reference/bluetooth/esp_bt_device.rst
+1 -1
View File
@@ -18,4 +18,4 @@ Application Example
API Reference
-------------
.. include:: /_build/inc/esp_bt_device.inc
.. include-build-file:: inc/esp_bt_device.inc
docs/en/api-reference/bluetooth/esp_bt_main.rst
+1 -1
View File
@@ -17,6 +17,6 @@ Application Example
API Reference
-------------
.. include:: /_build/inc/esp_bt_main.inc
.. include-build-file:: inc/esp_bt_main.inc
docs/en/api-reference/bluetooth/esp_gap_ble.rst
+1 -1
View File
@@ -26,5 +26,5 @@ Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which conta
API Reference
-------------
.. include:: /_build/inc/esp_gap_ble_api.inc
.. include-build-file:: inc/esp_gap_ble_api.inc
docs/en/api-reference/bluetooth/esp_gap_bt.rst
+1 -1
View File
@@ -16,5 +16,5 @@ Application Example
API Reference
-------------
.. include:: /_build/inc/esp_gap_bt_api.inc
.. include-build-file:: inc/esp_gap_bt_api.inc
docs/en/api-reference/bluetooth/esp_gatt_defs.rst
+1 -1
View File
@@ -16,6 +16,6 @@ Application Example
API Reference
-------------
.. include:: /_build/inc/esp_gatt_defs.inc
.. include-build-file:: inc/esp_gatt_defs.inc
docs/en/api-reference/bluetooth/esp_gattc.rst
+1 -1
View File
@@ -30,5 +30,5 @@ Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which conta
API Reference
-------------
.. include:: /_build/inc/esp_gattc_api.inc
.. include-build-file:: inc/esp_gattc_api.inc
docs/en/api-reference/bluetooth/esp_gatts.rst
+1 -1
View File
@@ -30,5 +30,5 @@ Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which conta
API Reference
-------------
.. include:: /_build/inc/esp_gatts_api.inc
.. include-build-file:: inc/esp_gatts_api.inc
docs/en/api-reference/bluetooth/esp_hf_client.rst
+1 -1
View File
@@ -11,4 +11,4 @@ Overview
API Reference
-------------
.. include:: /_build/inc/esp_hf_client_api.inc
.. include-build-file:: inc/esp_hf_client_api.inc
docs/en/api-reference/bluetooth/esp_hf_defs.rst
+1 -1
View File
@@ -11,6 +11,6 @@ Overview
API Reference
-------------
.. include:: /_build/inc/esp_hf_defs.inc
.. include-build-file:: inc/esp_hf_defs.inc
docs/en/api-reference/bluetooth/esp_spp.rst
+1 -1
View File
@@ -18,5 +18,5 @@ Check :example:`bluetooth/bluedroid/classic_bt` folder in ESP-IDF examples, whic
API Reference
-------------
.. include:: /_build/inc/esp_spp_api.inc
.. include-build-file:: inc/esp_spp_api.inc
docs/en/api-reference/bluetooth/nimble/index.rst
+1 -1
View File
@@ -41,4 +41,4 @@ This documentation does not cover NimBLE APIs. Refer to `NimBLE tutorial <https:
API Reference
=============
.. include:: /_build/inc/esp_nimble_hci.inc
.. include-build-file:: inc/esp_nimble_hci.inc