mirror of
https://github.com/espressif/esp-idf.git
synced 2026-05-05 04:15:21 +02:00
docs: add new top-level docs builder that builds docs for a single chip
This commit is contained in:
Angus Gratton
committed by
Angus Gratton
Angus Gratton
parent
783856d557
commit
e6211c7864
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user