eaw/esp-idf
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feature/docs_gh_link_roles' into 'master'

Browse Source 
docs: use custom roles to generate GitHub links

This change replaces direct links to GitHub master branch with
auto-generated links using docutils custom roles.
These auto-generated links point to the tree or blob for the git commit
ID (or tag) of the repository. This is needed to ensure that links don’t
become broken when files in master branch are moved around or deleted.

The following roles are introduced:

```
- :idf:`path` - points to directory inside ESP-IDF
- :idf_blob:`path` - points to file inside ESP-IDF
- :idf_raw:`path` - points to raw view of the file inside ESP-IDF
- :component:`path` - points to directory inside ESP-IDF components dir
- :component_blob:`path` - points to file inside ESP-IDF components dir
- :component_raw:`path` - points to raw view of the file inside ESP-IDF
  components dir
- :example:`path` - points to directory inside ESP-IDF examples dir
- :example_blob:`path` - points to file inside ESP-IDF examples dir
- :example_raw:`path` - points to raw view of the file inside ESP-IDF
  examples dir
```

A check is added to the CI build script, which searches RST files for
presence of hard-coded links (identified by tree/master, blob/master,
or raw/master part of the URL).
This check can be run manually: cd docs && make gh-linkcheck

Additionally, Sphinx linkcheck build type is used to create new CI test,
which check for broken links. This test has to be triggered explicitly,
because including it in normal build process (when the commit is not yet
deployed to Github) will not work. It can be triggered in a regular
fashion using a combination of cron and Curl, similar to stress tests.

See merge request !455
This commit is contained in:
Ivan Grokhotkov
2017-01-20 17:47:34 +08:00
parent fab35cb307 15072028c4
commit 632bd0bb4f
52 changed files with 187 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/bluetooth/controller_vhci.rst
View File

@@ -11,9 +11,9 @@ Overview
Application Example
-------------------
Check `/examples/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf/>`_ repository, that contains the following example:
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following example:
`ble_adv <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/ble_adv>`_
:example:`bluetooth/ble_adv`
This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising.
@@ -23,7 +23,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/include/bt.h <https://github.com/espressif/esp-idf/blob/master/components/bt/include/bt.h>`_
* :component_file:`bt/include/bt.h`
Type Definitions
^^^^^^^^^^^^^^^^

6
docs/api/bluetooth/esp_blufi.rst
View File

@@ -11,9 +11,9 @@ Use should concern these things:
Application Example
-------------------
Check `/examples/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that contains the following example:
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following example:
`blufi <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/blufi>`_
:example:`bluetooth/blufi`
This is a BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections.
@@ -24,7 +24,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/bluedroid/api/include/esp_blufi_api.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_blufi_api.h>`_
* :component_file:`bt/bluedroid/api/include/esp_blufi_api.h`
Macros
^^^^^^

2
docs/api/bluetooth/esp_bt_defs.rst
View File

@@ -20,7 +20,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/bluedroid/api/include/esp_bt_defs.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_bt_defs.h>`_
* :component_file:`bt/bluedroid/api/include/esp_bt_defs.h`
Macros

2
docs/api/bluetooth/esp_bt_device.rst
View File

@@ -22,7 +22,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/bluedroid/api/include/esp_bt_device.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_bt_device.h>`_
* :component_file:`bt/bluedroid/api/include/esp_bt_device.h`
Macros

2
docs/api/bluetooth/esp_bt_main.rst
View File

@@ -20,7 +20,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/bluedroid/api/include/esp_bt_main.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_bt_main.h>`_
* :component_file:`bt/bluedroid/api/include/esp_bt_main.h`
Macros

8
docs/api/bluetooth/esp_gap_ble.rst
View File

@@ -11,11 +11,11 @@ Overview
Application Example
-------------------
Check `/examples/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that contains the following examples:
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following examples:
`gatt_server <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_server>`_, `gatt_client <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_client>`_
:example:`bluetooth/gatt_server`, :example:`bluetooth/gatt_client`
The two demos use different gap api, such like advertising, scan, set device name and others.
The two demos use different GAP APIs, such like advertising, scan, set device name and others.
API Reference
-------------
@@ -23,7 +23,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/bluedroid/api/include/esp_gap_ble_api.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_gap_ble_api.h>`_
* :component_file:`bt/bluedroid/api/include/esp_gap_ble_api.h`
Macros

2
docs/api/bluetooth/esp_gatt_defs.rst
View File

@@ -20,7 +20,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/bluedroid/api/include/esp_gatt_defs.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_gatt_defs.h>`_
* :component_file:`bt/bluedroid/api/include/esp_gatt_defs.h`
Macros

8
docs/api/bluetooth/esp_gattc.rst
View File

@@ -11,11 +11,11 @@ Overview
Application Example
-------------------
Check `/examples/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that contains the following example:
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following examples:
`gatt_client <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_client>`_
:example:`bluetooth/gatt_client`
This is a gatt client demo. This demo can scan devices, connect to the gatt server and discover the service.
This is a GATT client demo. This demo can scan devices, connect to the GATT server and discover the service.
API Reference
@@ -24,7 +24,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/bluedroid/api/include/esp_gattc_api.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_gattc_api.h>`_
* :component_file:`bt/bluedroid/api/include/esp_gattc_api.h`
Macros
^^^^^^

8
docs/api/bluetooth/esp_gatts.rst
View File

@@ -11,11 +11,11 @@ Overview
Application Example
-------------------
Check `/examples/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that contains the following example:
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following example:
`gatt_server <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_server>`_
:example:`bluetooth/gatt_server`
This is a gatt server demo. Use gatt api to create a gatt server with send advertising. This gatt server can be connected and the service can be discovery.
This is a GATT server demo. Use GATT API to create a GATT server with send advertising. This GATT server can be connected and the service can be discovery.
API Reference
-------------
@@ -23,7 +23,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `bt/bluedroid/api/include/esp_gatts_api.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_gatts_api.h>`_
* :component_file:`bt/bluedroid/api/include/esp_gatts_api.h`
Macros
^^^^^^

2
docs/api/bluetooth/index.rst
View File

@@ -9,4 +9,4 @@ Bluetooth API
Bluetooth LE <bt_le>
Example code for this API section is provided in `examples/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ directory of ESP-IDF repository.
Example code for this API section is provided in :example:`bluetooth` directory of ESP-IDF examples.

4
docs/api/ethernet/esp_eth.rst
View File

@@ -4,7 +4,7 @@ ETHERNET
Application Example
-------------------
ethernet example: `examples/ethernet/ethernet <https://github.com/espressif/esp-idf/tree/master/examples/ethernet/ethernet>`_.
Ethernet example: :example:`ethernet/ethernet`.
API Reference
-------------
@@ -12,7 +12,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `components/ethernet/include/esp_eth.h <https://github.com/espressif/esp-idf/blob/master/components/ethernet/include/esp_eth.h>`_
* :component_file:`ethernet/include/esp_eth.h`
Macros
^^^^^^

2
docs/api/ethernet/index.rst
View File

@@ -7,4 +7,4 @@ Ethernet API
Ethernet <esp_eth>
Example code for this API section is provided in `examples/ethernet <https://github.com/espressif/esp-idf/tree/master/examples/ethernet>`_ directory of ESP-IDF repository.
Example code for this API section is provided in :example:`ethernet` directory of ESP-IDF examples.

4
docs/api/peripherals/gpio.rst
View File

@@ -10,7 +10,7 @@ Note that GPIO6-11 are usually used for SPI flash. GPIO34-39 can only be set as
Application Example
-------------------
GPIO output and input interrupt example: `examples/peripherals/gpio <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/gpio>`_.
GPIO output and input interrupt example: :example:`peripherals/gpio`.
API Reference
-------------
@@ -18,7 +18,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `driver/include/driver/driver/gpio.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/gpio.h>`_
* :component_file:`driver/include/driver/gpio.h`
Macros
^^^^^^

4
docs/api/peripherals/i2c.rst
View File

@@ -9,7 +9,7 @@ ESP32 has two I2C controllers which can be set as master mode or slave mode.
Application Example
-------------------
I2C master and slave example: `examples/peripherals/i2c <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/i2c>`_.
I2C master and slave example: :example:`peripherals/i2c`.
API Reference
-------------
@@ -17,7 +17,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `driver/include/driver/i2c.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/i2c.h>`_
* :component_file:`driver/include/driver/i2c.h`
Macros
^^^^^^

2
docs/api/peripherals/index.rst
View File

@@ -15,4 +15,4 @@ Peripherals API
Remote Control <rmt>
Example code for this API section is provided in `examples/peripherals <https://github.com/espressif/esp-idf/tree/master/examples/peripherals>`_ directory of ESP-IDF repository.
Example code for this API section is provided in :example:`peripherals` directory of ESP-IDF examples.

4
docs/api/peripherals/ledc.rst
View File

@@ -12,7 +12,7 @@ decrease the duty cycle gradually, allowing for fades without any processor inte
Application Example
-------------------
LEDC change duty cycle and fading control example: `examples/peripherals/ledc <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/ledc>`_.
LEDC change duty cycle and fading control example: :example:`peripherals/ledc`.
API Reference
-------------
@@ -20,7 +20,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `driver/include/driver/ledc.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/ledc.h>`_
* :component_file:`driver/include/driver/ledc.h`
Macros
^^^^^^

4
docs/api/peripherals/pcnt.rst
View File

@@ -9,7 +9,7 @@ The PCNT (Pulse Counter) module is designed to count the number of rising and/or
Application Example
-------------------
Pulse counter with control signal and event interrupt example: `examples/peripherals/pcnt <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/pcnt>`_.
Pulse counter with control signal and event interrupt example: :example:`peripherals/pcnt`.
API Reference
-------------
@@ -17,7 +17,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `driver/pcnt.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/pcnt.h>`_
* :component_file:`driver/include/driver/pcnt.h`
Macros

4
docs/api/peripherals/rmt.rst
View File

@@ -9,7 +9,7 @@ The RMT (Remote Control) module driver can be used to send and receive infrared
Application Example
-------------------
NEC remote control TX and RX example: `examples/peripherals/rmt_nec_tx_rx <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/rmt_nec_tx_rx>`_.
NEC remote control TX and RX example: :example:`peripherals/rmt_nec_tx_rx`.
API Reference
-------------
@@ -17,7 +17,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `driver/rmt.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/rmt.h>`_
* :component_file:`driver/include/driver/rmt.h`
Macros
^^^^^^

4
docs/api/peripherals/sigmadelta.rst
View File

@@ -10,7 +10,7 @@ This driver configures the channels of the sigma-delta module.
Application Example
-------------------
Sigma-delta Modulation example: `examples/peripherals/sigmadelta <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/sigmadelta>`_.
Sigma-delta Modulation example: :example:`peripherals/sigmadelta`.
API Reference
-------------
@@ -18,7 +18,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `driver/sigmadelta.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/sigmadelta.h>`_
* :component_file:`driver/include/driver/sigmadelta.h`
Macros

4
docs/api/peripherals/spi_master.rst
View File

@@ -108,7 +108,7 @@ as ``tx_data`` and ``rx_data``.
Application Example
-------------------
Display graphics on the ILI9341-based 320x240 LCD: `examples/peripherals/spi_master <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/spi_master>`_.
Display graphics on the ILI9341-based 320x240 LCD: :example:`peripherals/spi_master`.
API Reference
-------------
@@ -116,7 +116,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `driver/include/driver/spi_master.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/spi_master.h>`_
* :component_file:`driver/include/driver/spi_master.h`
Macros
^^^^^^

4
docs/api/peripherals/timer.rst
View File

@@ -12,7 +12,7 @@ They are all 64-bit generic timers based on 16-bit prescalers and 64-bit auto-re
Application Example
-------------------
64-bit hardware timer example: `examples/peripherals/timer_group <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/timer_group>`_.
64-bit hardware timer example: :example:`peripherals/timer_group`.
API Reference
-------------
@@ -20,7 +20,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `components/driver/timer.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/timer.h>`_
* :component_file:`driver/include/driver/timer.h`
Macros
^^^^^^

4
docs/api/peripherals/uart.rst
View File

@@ -11,7 +11,7 @@ Overview
Application Example
-------------------
Configure uart settings and install uart driver to read/write using UART0 and UART1 interfaces: `examples/peripherals/uart <https://github.com/espressif/esp-idf/tree/master/examples/peripherals/uart>`_.
Configure uart settings and install uart driver to read/write using UART0 and UART1 interfaces: :example:`peripherals/uart`.
API Reference
-------------
@@ -19,7 +19,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `driver/include/driver/uart.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/uart.h>`_
* :component_file:`driver/include/driver/uart.h`
Data Structures
^^^^^^^^^^^^^^^

2
docs/api/protocols/index.rst
View File

@@ -7,4 +7,4 @@ Protocols API
mDNS <mdns>
Example code for this API section is provided in `examples/protocols <https://github.com/espressif/esp-idf/tree/master/examples/protocols>`_ directory of ESP-IDF repository.
Example code for this API section is provided in :example:`protocols` directory of ESP-IDF examples.

4
docs/api/protocols/mdns.rst
View File

@@ -163,7 +163,7 @@ Example of using the methods above:
Application Example
-------------------
mDNS server/scanner example: `examples/protocols/mdns <https://github.com/espressif/esp-idf/tree/master/examples/protocols/mdns>`_.
mDNS server/scanner example: :example:`protocols/mdns`.
API Reference
-------------
@@ -171,7 +171,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `components/mdns/include/mdns.h <https://github.com/espressif/esp-idf/blob/master/components/mdns/include/mdns.h>`_
* :component_file:`mdns/include/mdns.h`
Macros
^^^^^^

2
docs/api/storage/index.rst
View File

@@ -11,4 +11,4 @@ Storage API
FAT Filesystem <fatfs>
Example code for this API section is provided in `examples/storage <https://github.com/espressif/esp-idf/tree/master/examples/storage>`_ directory of ESP-IDF repository.
Example code for this API section is provided in :example:`storage` directory of ESP-IDF examples.

10
docs/api/storage/nvs_flash.rst
View File

@@ -3,9 +3,9 @@
Application Example
-------------------
Two examples are provided in ESP-IDF `examples/storage <https://github.com/espressif/esp-idf/tree/master/examples/storage>`_ directory:
Two examples are provided in :example:`storage` directory of ESP-IDF examples:
`nvs_rw_value <https://github.com/espressif/esp-idf/blob/master/examples/storage/nvs_rw_value>`_
:example:`storage/nvs_rw_value`
Demonstrates how to read and write a single integer value using NVS.
@@ -13,7 +13,7 @@ Two examples are provided in ESP-IDF `examples/storage <https://github.com/espre
Example also shows how to check if read / write operation was successful, or certain value is not initialized in NVS. Diagnostic is provided in plain text to help track program flow and capture any issues on the way.
`nvs_rw_blob <https://github.com/espressif/esp-idf/blob/master/examples/storage/nvs_rw_blob>`_
:example:`storage/nvs_rw_blob`
Demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP32 module restarts.
@@ -29,8 +29,8 @@ API Reference
Header Files
^^^^^^^^^^^^
* `nvs_flash/include/nvs_flash.h <https://github.com/espressif/esp-idf/blob/master/components/nvs_flash/include/nvs_flash.h>`_
* `nvs_flash/include/nvs.h <https://github.com/espressif/esp-idf/blob/master/components/nvs_flash/include/nvs.h>`_
* :component_file:`nvs_flash/include/nvs_flash.h`
* :component_file:`nvs_flash/include/nvs.h`
Macros
^^^^^^

4
docs/api/storage/spi_flash.rst
View File

@@ -13,8 +13,8 @@ API Reference
Header Files
^^^^^^^^^^^^
* `spi_flash/include/esp_spi_flash.h <https://github.com/espressif/esp-idf/blob/master/components/spi_flash/include/esp_spi_flash.h>`_
* `spi_flash/include/esp_partition.h <https://github.com/espressif/esp-idf/blob/master/components/spi_flash/include/esp_partition.h>`_
* :component_file:`spi_flash/include/esp_spi_flash.h`
* :component_file:`spi_flash/include/esp_partition.h`
Macros
^^^^^^

4
docs/api/storage/vfs.rst
View File

@@ -13,8 +13,8 @@ API Reference
Header Files
^^^^^^^^^^^^
* `vfs/include/esp_vfs.h <https://github.com/espressif/esp-idf/blob/master/components/vfs/include/esp_vfs.h>`_
* `vfs/include/esp_vfs_dev.h <https://github.com/espressif/esp-idf/blob/master/components/vfs/include/esp_vfs_dev.h>`_
* :component_file:`vfs/include/esp_vfs.h`
* :component_file:`vfs/include/esp_vfs_dev.h`
Macros
^^^^^^

2
docs/api/system/deep_sleep.rst
View File

@@ -90,5 +90,5 @@ The following function can be used to enter deep sleep once wakeup sources are c
Application Example
-------------------
Implementation of basic functionality of deep sleep is shown in `protocols/sntp <https://github.com/espressif/esp-idf/tree/master/examples/protocols/sntp>`_ example, where ESP module is periodically waken up to retrive time from NTP server.
Implementation of basic functionality of deep sleep is shown in :example:`protocols/sntp` example, where ESP module is periodically waken up to retrive time from NTP server.

2
docs/api/system/index.rst
View File

@@ -12,4 +12,4 @@ System API
Logging <log>
Example code for this API section is provided in `examples/system <https://github.com/espressif/esp-idf/tree/master/examples/system>`_ directory of ESP-IDF repository.
Example code for this API section is provided in :example:`system` directory of ESP-IDF examples.

2
docs/api/system/intr_alloc.rst
View File

@@ -66,7 +66,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `esp_intr_alloc.h <https://github.com/espressif/esp-idf/blob/master/components/esp32/include/esp_intr_alloc.h>`_
* :component_file:`esp32/include/esp_intr_alloc.h`
Macros

10
docs/api/system/log.rst
View File

@@ -3,11 +3,11 @@
Application Example
-------------------
Log library is commonly used by most of esp-idf components and examples. For demonstration of log functionality check `examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that among others, contains the following examples:
Log library is commonly used by most of esp-idf components and examples. For demonstration of log functionality check :idf:`examples` folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that among others, contains the following examples:
* `system/ota <https://github.com/espressif/esp-idf/tree/master/examples/system/ota>`_
* `storage/sd_card <https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card>`_
* `protocols/https_request <https://github.com/espressif/esp-idf/tree/master/examples/protocols/https_request>`_
* :example:`system/ota`
* :example:`storage/sd_card`
* :example:`protocols/https_request`
API Reference
-------------
@@ -15,7 +15,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `log/include/esp_log.h <https://github.com/espressif/esp-idf/blob/master/components/log/include/esp_log.h>`_
* :component_file:`log/include/esp_log.h`
Macros
^^^^^^

4
docs/api/system/mem_alloc.rst
View File

@@ -37,8 +37,8 @@ API Reference
Header Files
^^^^^^^^^^^^
* `esp_heap_alloc_caps.h <https://github.com/espressif/esp-idf/blob/master/components/esp32/include/esp_heap_alloc_caps.h>`_
* `heap_regions.h <https://github.com/espressif/esp-idf/blob/master/components/freertos/include/freertos/heap_regions.h>`_
* :component_file:`esp32/include/esp_heap_alloc_caps.h`
* :component_file:`freertos/include/freertos/heap_regions.h`
Macros

4
docs/api/system/ota.rst
View File

@@ -4,7 +4,7 @@ OTA
Application Example
-------------------
Demonstration of OTA (over the air) firmware update workflow: `examples/system/ota <https://github.com/espressif/esp-idf/tree/master/examples/system/ota>`_.
Demonstration of OTA (over the air) firmware update workflow: :example:`system/ota`.
API Reference
-------------
@@ -12,7 +12,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `app_update/include/esp_ota_ops.h <https://github.com/espressif/esp-idf/blob/master/components/app_update/include/esp_ota_ops.h>`_
* :component_file:`app_update/include/esp_ota_ops.h`
Macros
^^^^^^

4
docs/api/system/wdts.rst
View File

@@ -59,8 +59,8 @@ API Reference
Header Files
^^^^^^^^^^^^
* `esp32/include/esp_int_wdt.h <https://github.com/espressif/esp-idf/blob/master/components/esp32/include/esp_int_wdt.h>`_
* `esp32/include/esp_task_wdt.h <https://github.com/espressif/esp-idf/blob/master/components/esp32/include/esp_task_wdt.h>`_
* :component_file:`esp32/include/esp_int_wdt.h`
* :component_file:`esp32/include/esp_task_wdt.h`
Functions

2
docs/api/wifi/esp_smartconfig.rst
View File

@@ -7,7 +7,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `esp32/include/esp_smartconfig.h <https://github.com/espressif/esp-idf/blob/master/components/esp32/include/esp_smartconfig.h>`_
* :component_file:`esp32/include/esp_smartconfig.h`
Type Definitions
^^^^^^^^^^^^^^^^

2
docs/api/wifi/esp_wifi.rst
View File

@@ -19,7 +19,7 @@ API Reference
Header Files
^^^^^^^^^^^^
* `esp32/include/esp_wifi.h <https://github.com/espressif/esp-idf/blob/master/components/esp32/include/esp_wifi.h>`_
* :component_file:`esp32/include/esp_wifi.h`
Macros
------

2
docs/api/wifi/index.rst
View File

@@ -8,4 +8,4 @@ Wi-Fi API
Smart Config <esp_smartconfig>
Example code for this API section is provided in `examples/wifi <https://github.com/espressif/esp-idf/tree/master/examples/wifi>`_ directory of ESP-IDF repository.
Example code for this API section is provided in :example:`wifi` directory of ESP-IDF examples.