docs/_build/
docs/doxygen-warning-log.txt
docs/xml/
+docs/man/
# Unit test app files
tools/unit-test-app/sdkconfig
- doxygen
# If not building master branch, and there are Doxygen warnings, print them and bail out
- test "${CI_BUILD_REF_NAME}" = "master" || test $(cat doxygen-warning-log.txt | wc -l) -eq 0 || ( echo "Doxygen pass had some warnings:" && cat doxygen-warning-log.txt && false )
+ - make gh-linkcheck
- make html
artifacts:
paths:
- scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH
- ssh $DOCS_SERVER -x "cd $DOCS_PATH && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
+check_doc_links:
+ stage: test
+ image: espressif/esp32-ci-env
+ tags:
+ - check_doc_links
+ only:
+ # can only be triggered
+ - triggers
+ script:
+ # must be triggered with CHECK_LINKS=Yes, otherwise exit without test
+ - test $CHECK_LINKS = "Yes" || exit 0
+ # can only run on master branch (otherwise the commit is not on Github yet)
+ - test "${CI_BUILD_REF_NAME}" = "master" || exit 0
+ - cd docs
+ - make linkcheck
+ artifacts:
+ paths:
+ - docs/_build/linkcheck
+ expire_in: 1 mos
+
# AUTO GENERATED PART START, DO NOT MODIFY CONTENT BELOW
# template for test jobs
* Is the code adequately commented for people to understand how it is structured?
-* Is there documentation or examples that go with code contributions? `There are additional suggestions for writing good examples in the examples README <https://github.com/espressif/esp-idf/tree/master/examples>`_.
+* Is there documentation or examples that go with code contributions? There are additional suggestions for writing good examples in :idf:`examples` readme.
* Are comments and documentation written in clear English, with no spelling or grammar errors?
fprintf(__getreent()->_stderr, "42\n");
-where the ``__getreent()`` function returns a per-task pointer to ``struct _reent`` (`source <https://github.com/espressif/esp-idf/blob/master/components/newlib/include/sys/reent.h#L370-L417>`_). This structure is allocated on the TCB of each task. When a task is initialized, ``_stdin``, ``_stdout`` and ``_stderr`` members of ``struct _reent`` are set to the values of ``_stdin``, ``_stdout`` and ``_stderr`` of ``_GLOBAL_REENT`` (i.e. the structure which is used before FreeRTOS is started).
+where the ``__getreent()`` function returns a per-task pointer to ``struct _reent`` (:component_file:`newlib/include/sys/reent.h#L370-L417>`). This structure is allocated on the TCB of each task. When a task is initialized, ``_stdin``, ``_stdout`` and ``_stderr`` members of ``struct _reent`` are set to the values of ``_stdin``, ``_stdout`` and ``_stderr`` of ``_GLOBAL_REENT`` (i.e. the structure which is used before FreeRTOS is started).
Such a design has the following consequences:
* Xtensa header files (components/esp32/include/xtensa) are Copyright (C) 2013 Tensilica Inc and are licensed under the MIT License as reproduce in the individual header files.
-* `esptool.py`_ (bin/esptool.py) is Copyright (C) 2014-2016 Fredrik Ahlberg, Angus Gratton and is licensed under the GNU General Public License v2, as described in the file components/esptool_py/LICENSE.
+* `esptool.py`_ (components/esptool_py/esptool) is Copyright (C) 2014-2016 Fredrik Ahlberg, Angus Gratton and is licensed under the GNU General Public License v2, as described in the file components/esptool_py/LICENSE.
* Original parts of FreeRTOS_ (components/freertos) are Copyright (C) 2015 Real Time Engineers Ltd and is licensed under the GNU General Public License V2 with the FreeRTOS Linking Exception, as described in the file components/freertos/license.txt.
.. _Newlib: https://sourceware.org/newlib/
.. _FreeRTOS: http://freertos.org/
-.. _esptool.py: https://github.com/themadinventor/esptool
+.. _esptool.py: https://github.com/espressif/esptool
.. _LWIP: http://savannah.nongnu.org/projects/lwip/
.. _TinyBasic: https://github.com/BleuLlama/TinyBasicPlus
.. _miniz: https://code.google.com/archive/p/miniz/
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
+gh-linkcheck:
+ @echo "Checking for hardcoded GitHub links"
+ @if (find ../ -name '*.rst' | xargs grep \
+ 'https://github.com/espressif/esp-idf/tree\|https://github.com/espressif/esp-idf/blob\|https://github.com/espressif/esp-idf/raw'\
+ ); \
+ then \
+ echo "WARNINIG: Some .rst files contain hardcoded Github links."; \
+ echo "Please check above output and replace links with one of the following:"; \
+ echo "- :idf:\`dir\` - points to directory inside ESP-IDF"; \
+ echo "- :idf_blob:\`file\` - points to file inside ESP-IDF"; \
+ echo "- :idf_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \
+ echo "- :component:\`dir\` - points to directory inside ESP-IDF components dir"; \
+ echo "- :component_blob:\`file\` - points to file inside ESP-IDF components dir"; \
+ echo "- :component_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \
+ echo " components dir"; \
+ echo "- :example:\`dir\` - points to directory inside ESP-IDF examples dir"; \
+ echo "- :example_blob:\`file\` - points to file inside ESP-IDF examples dir"; \
+ echo "- :example_raw:\`file\` - points to raw view of the file inside ESP-IDF"; \
+ echo " examples dir"; \
+ echo "These link types will point to the correct GitHub version automatically"; \
+ exit 1; \
+ fi
+ @echo "No hardcoded links found"
+
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
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.
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
^^^^^^^^^^^^^^^^
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.
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
^^^^^^
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
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
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
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
-------------
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
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
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
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
^^^^^^
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
-------------
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
^^^^^^
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.
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
-------------
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
^^^^^^
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.
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
-------------
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
^^^^^^
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
-------------
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
^^^^^^
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.
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
-------------
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
^^^^^^
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
-------------
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
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
-------------
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
^^^^^^
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
-------------
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
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
-------------
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
^^^^^^
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
-------------
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
^^^^^^
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
-------------
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
^^^^^^^^^^^^^^^
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.
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
-------------
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
^^^^^^
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.
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.
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.
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
^^^^^^
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
^^^^^^
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
^^^^^^
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.
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.
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
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
-------------
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
^^^^^^
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
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
-------------
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
^^^^^^
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
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
^^^^^^^^^^^^^^^^
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
------
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.
The names are generated from the full name of the file, as given in COMPONENT_EMBED_FILES. Characters /, ., etc. are replaced with underscores. The _binary prefix in the symbol name is added by objcopy and is the same for both text and binary files.
-For an example of using this technique, see `examples/protocols/https_request <https://github.com/espressif/esp-idf/tree/master/examples/protocols/https_request>`_ - the certificate file contents are loaded from the text .pem file at compile time.
+For an example of using this technique, see :example:`protocols/https_request` - the certificate file contents are loaded from the text .pem file at compile time.
Fully Overriding The Component Makefile
import sys
import os
+import re
+from subprocess import call, Popen, PIPE
+import shlex
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('.'))
+from repo_util import run_cmd_get_output
# -- Run DoxyGen to prepare XML for Sphinx---------------------------------
# ref. https://github.com/rtfd/readthedocs.org/issues/388
-from subprocess import call, Popen, PIPE
-import shlex
-
call('doxygen')
-# -- Function to get output of a command ----------------------------------
-def run_cmd_get_output(cmd):
- process = Popen(shlex.split(cmd), stdout=PIPE)
- (output, err) = process.communicate()
- exit_code = process.wait()
- if exit_code != 0:
- raise RuntimeError('command line program has failed')
- return output
-
-
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = ['breathe']
+extensions = ['breathe', 'link-roles']
# Breathe extension variables
breathe_projects = { "esp32-idf": "xml/" }
# built documents.
#
-# Different setup depending if script is running on ReadTheDocs or elsewhere
-on_rtd = os.environ.get('READTHEDOCS') == 'True'
-if on_rtd:
- # The short X.Y version.
- # Apparently ReadTheDocs is getting confused by other version / release
- # ReadTheDocs is building specific or the latest release from GitHub.
- version = '1.0'
- release = '1.0'
-else:
- # This is supposed to be "the short X.Y version", but it's the only version
- # visible when you open index.html.
- # Display full version to make things less confusing.
- # If needed, nearest tag is returned by 'git describe --abbrev=0'.
- version = run_cmd_get_output('git describe')
- # The full version, including alpha/beta/rc tags.
- release = run_cmd_get_output('git describe')
+# Readthedocs largely ignores 'version' and 'release', and displays one of
+# 'latest', tag name, or branch name, depending on the build type.
+# Still, this is useful for non-RTD builds.
+# This is supposed to be "the short X.Y version", but it's the only version
+# visible when you open index.html.
+# Display full version to make things less confusing.
+version = run_cmd_get_output('git describe')
+# The full version, including alpha/beta/rc tags.
+# If needed, nearest tag is returned by 'git describe --abbrev=0'.
+release = version
+print 'Version: {0} Release: {1}'.format(version, release)
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
The purpose of this contributor agreement ("Agreement") is to clarify
and document the rights granted by contributors to Us. To make this
-document effective, please follow the instructions at
-https://github.com/espressif/esp-idf/blob/master/CONTRIBUTING.rst.
+document effective, please follow the instructions at
+:idf_file:`CONTRIBUTING.rst`
1. DEFINITIONS
~~~~~~~~~~~~~~
---------------------------
1. No worries. All the software you need is well documented. It is also open source and free. Start by checking `Sphinx <http://www.sphinx-doc.org/>`_ documentation. If you are not clear how to write using rst markup language, see `reStructuredText Primer <http://www.sphinx-doc.org/en/stable/rest.html>`_.
-2. Check the source files of this documentation to understand what is behind of what you see now on the screen. Sources are maintained on GitHub in `espressif/esp-idf`_ repository in `/docs <https://github.com/espressif/esp-idf/tree/master/docs>`_ folder. You can go directly to the source file of this page by scrolling up and clicking the link in the top right corner. When on GitHub, see what's really inside, open source files by clicking ``Raw`` button.
+2. Check the source files of this documentation to understand what is behind of what you see now on the screen. Sources are maintained on GitHub in `espressif/esp-idf`_ repository in :idf:`docs` folder. You can go directly to the source file of this page by scrolling up and clicking the link in the top right corner. When on GitHub, see what's really inside, open source files by clicking ``Raw`` button.
3. You will likely want to see how documentation builds and looks like before posting it on the GitHub. There are two options to do so:
* Install `Sphinx <http://www.sphinx-doc.org/>`_, `Breathe <https://breathe.readthedocs.io/>`_ and `Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ to build it locally. You would need a Linux machine for that.
--- /dev/null
+# based on http://protips.readthedocs.io/link-roles.html
+
+from docutils import nodes
+from repo_util import run_cmd_get_output
+
+def get_github_rev():
+ path = run_cmd_get_output('git rev-parse --short HEAD')
+ tag = run_cmd_get_output('git describe --exact-match')
+ print 'Git commit ID: ', path
+ if len(tag):
+ print 'Git tag: ', tag
+ path = tag
+ return path
+
+
+def setup(app):
+ baseurl = 'https://github.com/espressif/esp-idf'
+ rev = get_github_rev()
+ app.add_role('idf', autolink('{}/tree/{}/%s'.format(baseurl, rev)))
+ app.add_role('idf_file', autolink('{}/blob/{}/%s'.format(baseurl, rev)))
+ app.add_role('idf_raw', autolink('{}/raw/{}/%s'.format(baseurl, rev)))
+ app.add_role('component', autolink('{}/tree/{}/components/%s'.format(baseurl, rev)))
+ app.add_role('component_file', autolink('{}/blob/{}/components/%s'.format(baseurl, rev)))
+ app.add_role('component_raw', autolink('{}/raw/{}/components/%s'.format(baseurl, rev)))
+ app.add_role('example', autolink('{}/tree/{}/examples/%s'.format(baseurl, rev)))
+ app.add_role('example_file', autolink('{}/blob/{}/examples/%s'.format(baseurl, rev)))
+ app.add_role('example_raw', autolink('{}/raw/{}/examples/%s'.format(baseurl, rev)))
+
+def autolink(pattern):
+ def role(name, rawtext, text, lineno, inliner, options={}, content=[]):
+ url = pattern % (text,)
+ node = nodes.reference(rawtext, text, refuri=url, **options)
+ return [node], []
+ return role
Finding a project
-----------------
-As well as the `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ project mentioned in the setup guide, esp-idf comes with some example projects on github in the `examples <https://github.com/espressif/esp-idf/tree/master/examples>`_ directory.
+As well as the `esp-idf-template <https://github.com/espressif/esp-idf-template>`_ project mentioned in the setup guide, ESP-IDF comes with some example projects on github in the :idf:`examples` directory.
Once you've found the project you want to work with, change to its directory and you can configure and build it:
--- /dev/null
+import re
+import os
+
+def run_cmd_get_output(cmd):
+ return os.popen(cmd).read().strip()
* Run through the installer steps, and accept the "Run MSYS2 now" option at the end. A window will open with a MSYS2 terminal.
-* The ESP-IDF repository on github contains a script in the tools directory titled ``windows_install_prerequisites.sh``. If you haven't downloaded the ESP-IDF yet, that's OK - you can just `download that one file in Raw format from here <https://github.com/espressif/esp-idf/raw/master/tools/windows/windows_install_prerequisites.sh>`_. Save it somewhere on your computer.
+* The ESP-IDF repository on github contains a script in the tools directory titled ``windows_install_prerequisites.sh``. If you haven't downloaded the ESP-IDF yet, that's OK - you can just download that one file in Raw format from here: :idf_raw:`tools/windows/windows_install_prerequisites.sh`. Save it somewhere on your computer.
* Type the path to the shell script into the MSYS2 terminal window. You can type it as a normal Windows path, but use forward-slashes instead of back-slashes. ie: ``C:/Users/myuser/Downloads/windows_install_prerequisites.sh``. You can read the script beforehand to check what it does.
projects / esp-idf / commitdiff