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

2026-05-04 03:52:01 +02:00 · 2019-11-13 11:46:16 +08:00
parent 783856d557
commit e6211c7864
133 changed files with 566 additions and 637 deletions
@@ -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
@@ -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

@@ -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

@@ -18,6 +18,6 @@ Application Example
 API Reference
 -------------

-.. include:: /_build/inc/esp_avrc_api.inc
+.. include-build-file:: inc/esp_avrc_api.inc


@@ -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

@@ -17,5 +17,5 @@ Application Example
 API Reference
 -------------

-.. include:: /_build/inc/esp_bt_defs.inc
+.. include-build-file:: inc/esp_bt_defs.inc

@@ -18,4 +18,4 @@ Application Example
 API Reference
 -------------

-.. include:: /_build/inc/esp_bt_device.inc
+.. include-build-file:: inc/esp_bt_device.inc
@@ -17,6 +17,6 @@ Application Example
 API Reference
 -------------

-.. include:: /_build/inc/esp_bt_main.inc
+.. include-build-file:: inc/esp_bt_main.inc


@@ -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

@@ -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

@@ -16,6 +16,6 @@ Application Example
 API Reference
 -------------

-.. include:: /_build/inc/esp_gatt_defs.inc
+.. include-build-file:: inc/esp_gatt_defs.inc


@@ -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

@@ -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

@@ -11,4 +11,4 @@ Overview
 API Reference
 -------------

-.. include:: /_build/inc/esp_hf_client_api.inc
+.. include-build-file:: inc/esp_hf_client_api.inc
@@ -11,6 +11,6 @@ Overview
 API Reference
 -------------

-.. include:: /_build/inc/esp_hf_defs.inc
+.. include-build-file:: inc/esp_hf_defs.inc


@@ -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

@@ -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
@@ -5,4 +5,4 @@ This section lists various error code constants defined in ESP-IDF.

 For general information about error codes in ESP-IDF, see :doc:`Error Handling <../api-guides/error-handling>`.

-.. include:: /_build/inc/esp_err_defs.inc
+.. include-build-file:: inc/esp_err_defs.inc
@@ -85,7 +85,7 @@ Subsequent sections contain the list of available ESP-IDF options, automatically
 By convention, all option names are upper case with underscores. When Kconfig generates sdkconfig and sdkconfig.h files, option names are prefixed with ``CONFIG_``. So if an option ``ENABLE_FOO`` is defined in a Kconfig file and selected in menuconfig, then sdkconfig and sdkconfig.h files will have ``CONFIG_ENABLE_FOO`` defined. In this reference, option names are also prefixed with ``CONFIG_``, same as in the source code.


-.. include:: /_build/inc/kconfig.inc
+.. include-build-file:: inc/kconfig.inc

 Customisations
 ==============
@@ -37,24 +37,24 @@ Ethernet PHY Common Registers
 API Reference - Driver Model
 ----------------------------

-.. include:: /_build/inc/esp_eth.inc
+.. include-build-file:: inc/esp_eth.inc

 API Reference - Common Interface
 --------------------------------

-.. include:: /_build/inc/esp_eth_com.inc
+.. include-build-file:: inc/esp_eth_com.inc

 API Reference - MAC Interface
 -----------------------------

-.. include:: /_build/inc/esp_eth_mac.inc
+.. include-build-file:: inc/esp_eth_mac.inc

 API Reference - PHY Interface
 -----------------------------

-.. include:: /_build/inc/esp_eth_phy.inc
+.. include-build-file:: inc/esp_eth_phy.inc

 API Reference - Glue for esp_netif
 ----------------------------------

-.. include:: /_build/inc/esp_eth_netif_glue.inc
+.. include-build-file:: inc/esp_eth_netif_glue.inc
@@ -332,4 +332,4 @@ ESP-IDF contains these ESP-MESH example projects:
 API Reference
 --------------

-.. include:: /_build/inc/esp_mesh.inc
+.. include-build-file:: inc/esp_mesh.inc
@@ -168,10 +168,10 @@ configured with default settings, which as a consequence, means that:
 API Reference
 -------------

-.. include:: /_build/inc/esp_netif.inc
+.. include-build-file:: inc/esp_netif.inc


 WiFi default API reference
 ^^^^^^^^^^^^^^^^^^^^^^^^^^

-.. include:: /_build/inc/esp_wifi_default.inc
+.. include-build-file:: inc/esp_wifi_default.inc
@@ -94,4 +94,4 @@ The packet data path functions for transmitting and freeing the rx buffer (defin
 the esp-netif, specifically from its TCP/IP stack connecting layer. The following API reference outlines these network stack
 interaction with the esp-netif.

-.. include:: /_build/inc/esp_netif_net_stack.inc
+.. include-build-file:: inc/esp_netif_net_stack.inc
@@ -84,4 +84,4 @@ Instead, post the necessary data to a queue and handle it from a lower priority
 API Reference
 -------------

-.. include:: /_build/inc/esp_now.inc
+.. include-build-file:: inc/esp_now.inc
@@ -6,4 +6,4 @@ SmartConfig
 API Reference
 -------------

-.. include:: /_build/inc/esp_smartconfig.inc
+.. include-build-file:: inc/esp_smartconfig.inc
@@ -30,7 +30,7 @@ In addition, there is a simple `esp-idf-template <https://github.com/espressif/e
 API Reference
 -------------

-.. include:: /_build/inc/esp_wifi.inc
-.. include:: /_build/inc/esp_wifi_types.inc
+.. include-build-file:: inc/esp_wifi.inc
+.. include-build-file:: inc/esp_wifi_types.inc


@@ -224,18 +224,18 @@ This reference covers three components:
 ADC driver
 ^^^^^^^^^^

-.. include:: /_build/inc/adc.inc
+.. include-build-file:: inc/adc.inc

 .. _adc-api-reference-adc-calibration:

 ADC Calibration
 ^^^^^^^^^^^^^^^

-.. include:: /_build/inc/esp_adc_cal.inc
+.. include-build-file:: inc/esp_adc_cal.inc

 .. _adc-api-reference-gpio-lookup-macros:

 GPIO Lookup Macros
 ^^^^^^^^^^^^^^^^^^

-.. include:: /_build/inc/adc_channel.inc
+.. include-build-file:: inc/adc_channel.inc
@@ -485,5 +485,5 @@ Application Examples
 API Reference
 -------------

-.. include:: /_build/inc/can_types.inc
-.. include:: /_build/inc/can.inc
+.. include-build-file:: inc/can_types.inc
+.. include-build-file:: inc/can.inc
@@ -28,7 +28,7 @@ Setting DAC channel 1 (GPIO 25) voltage to approx 0.78 of VDD_A voltage (VDD * 2
 API Reference
 -------------

-.. include:: /_build/inc/dac.inc
+.. include-build-file:: inc/dac.inc

 GPIO Lookup Macros
 ^^^^^^^^^^^^^^^^^^
@@ -38,4 +38,4 @@ e.g.
 1. ``DAC_CHANNEL_1_GPIO_NUM`` is the GPIO number of channel 1 (25);
 2. ``DAC_GPIO26_CHANNEL`` is the channel number of GPIO 26 (channel 2).

-.. include:: /_build/inc/dac_channel.inc
+.. include-build-file:: inc/dac_channel.inc
@@ -19,10 +19,10 @@ GPIO output and input interrupt example: :example:`peripherals/gpio`.
 API Reference - Normal GPIO
 ---------------------------

-.. include:: /_build/inc/gpio.inc
+.. include-build-file:: inc/gpio.inc

 API Reference - RTC GPIO
 ------------------------

-.. include:: /_build/inc/rtc_io.inc
+.. include-build-file:: inc/rtc_io.inc

@@ -249,4 +249,4 @@ I2C master and slave example: :example:`peripherals/i2c`.
 API Reference
 -------------

-.. include:: /_build/inc/i2c.inc
+.. include-build-file:: inc/i2c.inc
@@ -208,5 +208,5 @@ Configuring I2S to use internal DAC for analog output
 API Reference
 -------------

-.. include:: /_build/inc/i2s.inc
+.. include-build-file:: inc/i2s.inc

@@ -175,5 +175,5 @@ The LEDC change duty cycle and fading control example: :example:`peripherals/led
 API Reference
 -------------

-.. include:: /_build/inc/ledc.inc
+.. include-build-file:: inc/ledc.inc

@@ -175,6 +175,7 @@ Examples of using MCPWM for motor control: :example:`peripherals/mcpwm`:
 API Reference
 -------------

-.. include:: /_build/inc/mcpwm_types.inc
-.. include:: /_build/inc/mcpwm.inc
+.. include-build-file:: inc/mcpwm_types.inc
+.. include-build-file:: inc/mcpwm.inc
+

@@ -92,5 +92,5 @@ Pulse counter with control signal and event interrupt example: :example:`periphe
 API Reference
 -------------

-.. include:: /_build/inc/pcnt.inc
+.. include-build-file:: inc/pcnt.inc

@@ -264,5 +264,5 @@ Application Examples
 API Reference
 -------------

-.. include:: /_build/inc/rmt.inc
+.. include-build-file:: inc/rmt.inc

@@ -277,6 +277,7 @@ Slave/master communication: :example:`peripherals/sdio`.
 API Reference
 -------------

-.. include:: /_build/inc/sdio_slave_types.inc
-.. include:: /_build/inc/sdio_slave.inc
+.. include-build-file:: inc/sdio_slave_types.inc
+.. include-build-file:: inc/sdio_slave.inc
+

@@ -106,4 +106,4 @@ See :doc:`sd_pullup_requirements` for pullup support and compatibilities of modu
 API Reference
 -------------

-.. include:: /_build/inc/sdmmc_host.inc
+.. include-build-file:: inc/sdmmc_host.inc
@@ -47,4 +47,4 @@ Other functions are mostly used by the protocol level SD/SDIO/MMC driver via fun
 API Reference
 -------------

-.. include:: /_build/inc/sdspi_host.inc
+.. include-build-file:: inc/sdspi_host.inc
@@ -29,4 +29,4 @@ Sigma-delta Modulation example: :example:`peripherals/sigmadelta`.
 API Reference
 -------------

-.. include:: /_build/inc/sigmadelta.inc
+.. include-build-file:: inc/sigmadelta.inc
@@ -455,12 +455,12 @@ The code example for displaying graphics on an ESP32-WROVER-KIT's 320x240 LCD sc
 API Reference - SPI Common
 --------------------------

-.. include:: /_build/inc/spi_types.inc
-.. include:: /_build/inc/spi_common.inc
+.. include-build-file:: inc/spi_types.inc
+.. include-build-file:: inc/spi_common.inc


 API Reference - SPI Master
 --------------------------

-.. include:: /_build/inc/spi_master.inc
+.. include-build-file:: inc/spi_master.inc

@@ -191,5 +191,5 @@ The code example for Device/Host communication can be found in the :example:`per
 API Reference
 -------------

-.. include:: /_build/inc/spi_slave.inc
+.. include-build-file:: inc/spi_slave.inc

@@ -29,4 +29,4 @@ Temperature sensor reading example: :example:`peripherals/temp_sensor`.
 API Reference - Normal Temp Sensor
 ----------------------------------

-.. include:: /_build/inc/temp_sensor.inc
+.. include-build-file:: inc/temp_sensor.inc
@@ -106,4 +106,4 @@ The 64-bit hardware timer example: :example:`peripherals/timer_group`.
 API Reference
 -------------

-.. include:: /_build/inc/timer.inc
+.. include-build-file:: inc/timer.inc
@@ -162,7 +162,7 @@ Application Examples
 API Reference
 -------------

-.. include:: /_build/inc/touch_pad.inc
+.. include-build-file:: inc/touch_pad.inc

 GPIO Lookup Macros
 ^^^^^^^^^^^^^^^^^^
@@ -172,5 +172,5 @@ e.g.
 1. ``TOUCH_PAD_NUM5_GPIO_NUM`` is the GPIO number of channel 5 (12);
 2. ``TOUCH_PAD_GPIO4_CHANNEL`` is the channel number of GPIO 4 (channel 0).

-.. include:: /_build/inc/touch_sensor_channel.inc
-.. include:: /_build/inc/touch_sensor_types.inc
+.. include-build-file:: inc/touch_sensor_channel.inc
+.. include-build-file:: inc/touch_sensor_types.inc
@@ -379,7 +379,7 @@ The table below describes the code examples available in the directory :example:
 API Reference
 -------------

-.. include:: /_build/inc/uart.inc
+.. include-build-file:: inc/uart.inc


 GPIO Lookup Macros
@@ -395,5 +395,5 @@ The UART peripherals have dedicated IO_MUX pins to which they are connected dire
 2. :c:macro:`UART_GPIO19_DIRECT_CHANNEL` returns the UART number of GPIO 19 when connected to the UART peripheral via IO_MUX (this is UART_NUM_0)
 3. :c:macro:`UART_CTS_GPIO19_DIRECT_CHANNEL` returns the UART number of GPIO 19 when used as the UART CTS pin via IO_MUX (this is UART_NUM_0). Similar to the above macro but specifies the pin function which is also part of the IO_MUX assignment.

-.. include:: /_build/inc/uart_channel.inc
+.. include-build-file:: inc/uart_channel.inc

@@ -188,4 +188,4 @@ HTTP Client example: :example:`protocols/esp_http_client`.
 API Reference
 -------------

-.. include:: /_build/inc/esp_http_client.inc
+.. include-build-file:: inc/esp_http_client.inc
@@ -155,4 +155,4 @@ Check the example under :example:`protocols/http_server/persistent_sockets`.
 API Reference
 -------------

-.. include:: /_build/inc/esp_http_server.inc
+.. include-build-file:: inc/esp_http_server.inc
@@ -47,4 +47,4 @@ The initial session setup can take about two seconds, or more with slower clock
 API Reference
 -------------

-.. include:: /_build/inc/esp_https_server.inc
+.. include-build-file:: inc/esp_https_server.inc
@@ -203,4 +203,4 @@ The various protocomm endpoints provided by **esp_local_ctrl** are listed below:
 API Reference
 -------------

-.. include:: /_build/inc/esp_local_ctrl.inc
+.. include-build-file:: inc/esp_local_ctrl.inc
@@ -150,5 +150,5 @@ Please refer to the specific example README.md for details.
 API Reference
 -------------

-.. include:: /_build/inc/essl.inc
-.. include:: /_build/inc/essl_sdio.inc
+.. include-build-file:: inc/essl.inc
+.. include-build-file:: inc/essl_sdio.inc
@@ -91,4 +91,4 @@ SSL/TLS libraries and with all respective configurations set to default.
 API Reference
 -------------

-.. include:: /_build/inc/esp_tls.inc
+.. include-build-file:: inc/esp_tls.inc
@@ -66,5 +66,5 @@ Simple WebSocket example that uses esp_websocket_client to establish a websocket
 API Reference
 -------------

-.. include:: /_build/inc/esp_websocket_client.inc
+.. include-build-file:: inc/esp_websocket_client.inc

@@ -117,6 +117,6 @@ ICMP echo example: :example:`protocols/icmp_echo`
 API Reference
 -------------

-.. include:: /_build/inc/ping_sock.inc
+.. include-build-file:: inc/ping_sock.inc


@@ -184,6 +184,6 @@ mDNS server/scanner example: :example:`protocols/mdns`.
 API Reference
 -------------

-.. include:: /_build/inc/mdns.inc
+.. include-build-file:: inc/mdns.inc


@@ -158,4 +158,4 @@ The following events may be posted by the MQTT client:
 API Reference
 -------------

-.. include:: /_build/inc/mqtt_client.inc
+.. include-build-file:: inc/mqtt_client.inc
@@ -166,9 +166,9 @@ For complete example see :example:`provisioning/ble_prov`
 API Reference
 -------------

-.. include:: /_build/inc/protocomm.inc
-.. include:: /_build/inc/protocomm_security.inc
-.. include:: /_build/inc/protocomm_security0.inc
-.. include:: /_build/inc/protocomm_security1.inc
-.. include:: /_build/inc/protocomm_httpd.inc
-.. include:: /_build/inc/protocomm_ble.inc
+.. include-build-file:: inc/protocomm.inc
+.. include-build-file:: inc/protocomm_security.inc
+.. include-build-file:: inc/protocomm_security0.inc
+.. include-build-file:: inc/protocomm_security1.inc
+.. include-build-file:: inc/protocomm_httpd.inc
+.. include-build-file:: inc/protocomm_ble.inc
@@ -279,8 +279,8 @@ For complete example implementation see :example:`provisioning/manager`
 API Reference
 -------------

-.. include:: /_build/inc/manager.inc
-.. include:: /_build/inc/scheme_ble.inc
-.. include:: /_build/inc/scheme_softap.inc
-.. include:: /_build/inc/scheme_console.inc
-.. include:: /_build/inc/wifi_config.inc
+.. include-build-file:: inc/manager.inc
+.. include-build-file:: inc/scheme_ble.inc
+.. include-build-file:: inc/scheme_softap.inc
+.. include-build-file:: inc/scheme_console.inc
+.. include-build-file:: inc/wifi_config.inc
@@ -31,8 +31,8 @@ You can find two code examples in the :example:`storage` directory of ESP-IDF ex
 API Reference
 -------------

-.. include:: /_build/inc/nvs_flash.inc
+.. include-build-file:: inc/nvs_flash.inc

-.. include:: /_build/inc/nvs.inc
+.. include-build-file:: inc/nvs.inc


@@ -100,6 +100,6 @@ Most applications need to use the protocol layer only in one task. For this reas
 API Reference
 -------------

-.. include:: /_build/inc/sdmmc_cmd.inc
+.. include-build-file:: inc/sdmmc_cmd.inc

-.. include:: /_build/inc/sdmmc_types.inc
+.. include-build-file:: inc/sdmmc_types.inc
@@ -31,18 +31,18 @@ In a single core environment (:ref:`CONFIG_FREERTOS_UNICORE` enabled), you need
 API Reference - SPI Flash
 -------------------------

-.. include:: /_build/inc/esp_flash_spi_init.inc
-.. include:: /_build/inc/esp_flash.inc
-.. include:: /_build/inc/spi_flash_types.inc
+.. include-build-file:: inc/esp_flash_spi_init.inc
+.. include-build-file:: inc/esp_flash.inc
+.. include-build-file:: inc/spi_flash_types.inc

 API Reference - Partition Table
 -------------------------------

-.. include:: /_build/inc/esp_partition.inc
+.. include-build-file:: inc/esp_partition.inc

 API Reference - Flash Encrypt
 -----------------------------

-.. include:: /_build/inc/esp_flash_encrypt.inc
+.. include-build-file:: inc/esp_flash_encrypt.inc


@@ -145,4 +145,4 @@ An example of using SPIFFS is provided in the :example:`storage/spiffs` director
 High-level API Reference
 ------------------------

-.. include:: /_build/inc/esp_spiffs.inc
+.. include-build-file:: inc/esp_spiffs.inc
@@ -10,7 +10,7 @@ Application Example
 API Reference
 -------------

-.. include:: /_build/inc/esp_vfs.inc
+.. include-build-file:: inc/esp_vfs.inc

-.. include:: /_build/inc/esp_vfs_dev.inc
+.. include-build-file:: inc/esp_vfs_dev.inc

@@ -30,5 +30,5 @@ Functions
 Mid level API Reference
 -----------------------

-.. include:: /_build/inc/wear_levelling.inc
+.. include-build-file:: inc/wear_levelling.inc

@@ -103,6 +103,6 @@ To guarantee that the custom structure is located in the image even if it is not
 API Reference
 -------------

-.. include:: /_build/inc/esp_app_format.inc
+.. include-build-file:: inc/esp_app_format.inc


@@ -14,6 +14,6 @@ Developers can use this library to send application specific state of execution
 API Reference
 -------------

-.. include:: /_build/inc/esp_app_trace.inc
-.. include:: /_build/inc/esp_sysview_trace.inc
+.. include-build-file:: inc/esp_app_trace.inc
+.. include-build-file:: inc/esp_sysview_trace.inc

@@ -341,4 +341,4 @@ To get a dump for all eFuse registers.
 	00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000


-.. include:: /_build/inc/esp_efuse.inc
+.. include-build-file:: inc/esp_efuse.inc
@@ -10,5 +10,5 @@ For the full list of error codes defined in ESP-IDF, see :doc:`Error Code Refere
 API Reference
 -------------

-.. include:: /_build/inc/esp_err.inc
+.. include-build-file:: inc/esp_err.inc

@@ -216,8 +216,8 @@ Other examples which also adopt esp_event library:
 API Reference
 -------------

-.. include:: /_build/inc/esp_event.inc
-.. include:: /_build/inc/esp_event_base.inc
+.. include-build-file:: inc/esp_event.inc
+.. include-build-file:: inc/esp_event_base.inc

 Related Documents
 -----------------
@@ -4,4 +4,4 @@ Legacy event loop
 API Reference
 -------------

-.. include:: /_build/inc/esp_event_legacy.inc
+.. include-build-file:: inc/esp_event_legacy.inc
@@ -51,6 +51,6 @@ The usage may looks like the code below:
 API Reference
 -------------

-.. include:: /_build/inc/esp_expression_with_stack.inc
+.. include-build-file:: inc/esp_expression_with_stack.inc


@@ -37,4 +37,4 @@ For additional security, signature of OTA firmware images can be verified. For t
 API Reference
 -------------

-.. include:: /_build/inc/esp_https_ota.inc
+.. include-build-file:: inc/esp_https_ota.inc
@@ -68,5 +68,5 @@ The API can also be used for inheriting the settings across threads. For example
 API Reference
 -------------

-.. include:: /_build/inc/esp_pthread.inc
+.. include-build-file:: inc/esp_pthread.inc

@@ -66,6 +66,6 @@ The following example illustrates usage of ``esp_timer`` APIs: :example:`system/
 API Reference
 -------------

-.. include:: /_build/inc/esp_timer.inc
+.. include-build-file:: inc/esp_timer.inc


@@ -13,27 +13,27 @@ and :doc:`ESP-IDF FreeRTOS Additions<freertos_additions>`.
 Task API
 --------

-.. include:: /_build/inc/task.inc
+.. include-build-file:: inc/task.inc

 Queue API
 ---------

-.. include:: /_build/inc/queue.inc
+.. include-build-file:: inc/queue.inc

 Semaphore API
 -------------

-.. include:: /_build/inc/semphr.inc
+.. include-build-file:: inc/semphr.inc

 Timer API
 ---------

-.. include:: /_build/inc/timers.inc
+.. include-build-file:: inc/timers.inc


 Event Group API
 ---------------

-.. include:: /_build/inc/event_groups.inc
+.. include-build-file:: inc/event_groups.inc


@@ -469,7 +469,7 @@ Ring Buffer API Reference
    of tasks using the ring buffer simultaneously is low, and the ring buffer is not operating
    near maximum capacity.

-.. include:: /_build/inc/ringbuf.inc
+.. include-build-file:: inc/ringbuf.inc


 .. _hooks:
@@ -518,4 +518,4 @@ in turn.
 Hooks API Reference
 -------------------

-.. include:: /_build/inc/esp_freertos_hooks.inc
+.. include-build-file:: inc/esp_freertos_hooks.inc
@@ -402,4 +402,4 @@ One way to differentiate between "real" and "false positive" memory leaks is to
 API Reference - Heap Tracing
 ----------------------------

-.. include:: /_build/inc/esp_heap_trace.inc
+.. include-build-file:: inc/esp_heap_trace.inc
@@ -30,4 +30,4 @@ An example doing a simple memory test of the high memory range is available in e
 API Reference
 -------------

-.. include:: /_build/inc/himem.inc
+.. include-build-file:: inc/himem.inc
@@ -100,6 +100,6 @@ or the status should be handled in other enabled interrupt properly**. You may l
 API Reference
 -------------

-.. include:: /_build/inc/esp_intr_alloc.inc
+.. include-build-file:: inc/esp_intr_alloc.inc


@@ -38,6 +38,6 @@ IPC, especially when attempting to take a mutex within the function.
 API Reference
 -------------

-.. include:: /_build/inc/esp_ipc.inc
+.. include-build-file:: inc/esp_ipc.inc


@@ -12,7 +12,7 @@ The logging library is commonly used by most esp-idf components and examples. Fo
 API Reference
 -------------

-.. include:: /_build/inc/esp_log.inc
+.. include-build-file:: inc/esp_log.inc



@@ -111,7 +111,7 @@ To use the region above the 4MiB limit, you can use the :doc:`himem API</api-ref
 API Reference - Heap Allocation
 -------------------------------

-.. include:: /_build/inc/esp_heap_caps.inc
+.. include-build-file:: inc/esp_heap_caps.inc

 Thread Safety
 ^^^^^^^^^^^^^
@@ -132,7 +132,7 @@ The following features are documented on the :doc:`Heap Memory Debugging </api-r
 API Reference - Initialisation
 ------------------------------

-.. include:: /_build/inc/esp_heap_caps_init.inc
+.. include-build-file:: inc/esp_heap_caps_init.inc

 Implementation Notes
 --------------------
@@ -150,4 +150,4 @@ API Reference - Multi Heap API

 (Note: The multi heap API is used internally by the heap capabilities allocator. Most IDF programs will never need to call this API directly.)

-.. include:: /_build/inc/multi_heap.inc
+.. include-build-file:: inc/multi_heap.inc
@@ -311,7 +311,7 @@ End-to-end example of OTA firmware update workflow: :example:`system/ota`.
 API Reference
 -------------

-.. include:: /_build/inc/esp_ota_ops.inc
+.. include-build-file:: inc/esp_ota_ops.inc



@@ -21,6 +21,6 @@ Header Files
 API Reference
 -------------

-.. include:: /_build/inc/xtensa_perfmon_access.inc
-.. include:: /_build/inc/xtensa_perfmon_apis.inc
+.. include-build-file:: inc/xtensa_perfmon_access.inc
+.. include-build-file:: inc/xtensa_perfmon_apis.inc

@@ -141,6 +141,6 @@ The following peripheral drivers are not aware of DFS yet. Applications need to
 API Reference
 -------------

-.. include:: /_build/inc/esp_pm.inc
-.. include:: /_build/inc/pm.inc
+.. include-build-file:: inc/esp_pm.inc
+.. include-build-file:: inc/pm.inc

@@ -163,6 +163,6 @@ More extensive example in :example:`system/deep_sleep` illustrates usage of vari
 API Reference
 -------------

-.. include:: /_build/inc/esp_sleep.inc
+.. include-build-file:: inc/esp_sleep.inc


@@ -162,7 +162,7 @@ If :ref:`CONFIG_APP_PROJECT_VER_FROM_CONFIG` option is set, the value of :ref:`C
 API Reference
 -------------

-.. include:: /_build/inc/esp_system.inc
-.. include:: /_build/inc/esp_idf_version.inc
+.. include-build-file:: inc/esp_system.inc
+.. include-build-file:: inc/esp_idf_version.inc


@@ -102,4 +102,4 @@ Task Watchdog API Reference

 A full example using the Task Watchdog is available in esp-idf: :example:`system/task_watchdog`

-.. include:: /_build/inc/esp_task_wdt.inc
+.. include-build-file:: inc/esp_task_wdt.inc
@@ -75,7 +75,7 @@ API Reference

    5. To show contents of ``*.inc`` file in documentation, include it as follows::

-       .. include:: /_build/inc/esp_wifi.inc
+       .. include-build-file:: inc/esp_wifi.inc

       For example see :idf_file:`docs/en/api-reference/wifi/esp_wifi.rst`