docs: add support for building H2 docs

This commit is contained in:
Marius Vikhammer
2023-01-06 15:25:58 +08:00
parent a786676d8d
commit 7100b7d1ff
27 changed files with 699 additions and 17 deletions

View File

@@ -0,0 +1,30 @@
.. This file gets included from other .rst files in this folder.
.. It contains target-specific snippets.
.. Comments and '---' lines act as delimiters.
..
.. This is necessary mainly because RST doesn't support substitutions
.. (defined in RST, not in Python) inside code blocks. If that is ever implemented,
.. These code blocks can be moved back to the main .rst files, with target-specific
.. file names being replaced by substitutions.
.. gpio-summary
The {IDF_TARGET_NAME} chip features X physical GPIO pins (GPIOX ~ GPIOX). Each pin can be used as a general-purpose I/O, or to be connected to an internal peripheral signal. Through GPIO matrix and IO MUX, peripheral input signals can be from any IO pins, and peripheral output signals can be routed to any IO pins. Together these modules provide highly configurable I/O. For more details, see *{IDF_TARGET_NAME} Technical Reference Manual* > *IO MUX and GPIO Matrix (GPIO, IO_MUX)* [`PDF <{IDF_TARGET_TRM_EN_URL}#iomuxgpio>`__].
The table below provides more information on pin usage, and please note the comments in the table for GPIOs with restrictions.
.. list-table::
:header-rows: 1
:widths: 8 12 12 20
* - GPIO
- Analog Function
- LP GPIO
- Comments
* - GPIO0
-
-
-
---

View File

@@ -25,7 +25,7 @@
- :ref:`gptimer-register-event-callbacks` - 如何将用户的特定代码挂载到警报事件回调函数。
- :ref:`enable-and-disable-timer` - 如何使能和禁用定时器。
- :ref:`start-and-stop-timer` - 通过不同报警行为启动定时器的典型使用场景。
:SOC_TIMER_SUPPORT_ETM: - :ref:`gptimer-etm-event-and-task` - 定时器提供了哪些事件和任务可以连接到 ETM 通道上。
:SOC_ETM_SUPPORTED and SOC_TIMER_SUPPORT_ETM: - :ref:`gptimer-etm-event-and-task` - 定时器提供了哪些事件和任务可以连接到 ETM 通道上。
- :ref:`gptimer-power-management` - 选择不同的时钟源将会如何影响功耗。
- :ref:`gptimer-iram-safe` - 在 cache 禁用的情况下,如何更好地让定时器处理中断事务以及实现 IO 控制功能。
- :ref:`gptimer-thread-safety` - 驱动程序保证哪些 API 线程安全。
@@ -260,7 +260,7 @@
ESP_ERROR_CHECK(gptimer_start(gptimer, &alarm_config));
.. only:: SOC_TIMER_SUPPORT_ETM
.. only:: SOC_ETM_SUPPORTED and SOC_TIMER_SUPPORT_ETM
.. _gptimer-etm-event-and-task:
@@ -273,7 +273,7 @@
.. _gptimer-power-management:
.. only:: not SOC_TIMER_SUPPORT_ETM
.. only:: not SOC_ETM_SUPPORTED or not SOC_TIMER_SUPPORT_ETM
.. _gptimer-power-management:

View File

@@ -0,0 +1,3 @@
.. code-block:: none
TO BE UPDATED

View File

@@ -0,0 +1,6 @@
+------------------------+
| Revision (Major.Minor) |
+------------------------+
| v0.0 |
+------------------------+

View File

@@ -0,0 +1,4 @@
.. code-block:: none
TO BE UPDATED