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

2025-09-22 17:02:25 +00:00 · 2019-11-13 11:46:16 +08:00
parent 783856d557
commit e6211c7864
133 changed files with 566 additions and 637 deletions
--- a/docs/en/api-reference/peripherals/adc.rst
+++ b/docs/en/api-reference/peripherals/adc.rst
@@ -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
--- a/docs/en/api-reference/peripherals/can.rst
+++ b/docs/en/api-reference/peripherals/can.rst
@@ -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
--- a/docs/en/api-reference/peripherals/dac.rst
+++ b/docs/en/api-reference/peripherals/dac.rst
@@ -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
--- a/docs/en/api-reference/peripherals/gpio.rst
+++ b/docs/en/api-reference/peripherals/gpio.rst
@@ -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

--- a/docs/en/api-reference/peripherals/i2c.rst
+++ b/docs/en/api-reference/peripherals/i2c.rst
@@ -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
--- a/docs/en/api-reference/peripherals/i2s.rst
+++ b/docs/en/api-reference/peripherals/i2s.rst
@@ -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

--- a/docs/en/api-reference/peripherals/ledc.rst
+++ b/docs/en/api-reference/peripherals/ledc.rst
@@ -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

--- a/docs/en/api-reference/peripherals/mcpwm.rst
+++ b/docs/en/api-reference/peripherals/mcpwm.rst
@@ -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
+

--- a/docs/en/api-reference/peripherals/pcnt.rst
+++ b/docs/en/api-reference/peripherals/pcnt.rst
@@ -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

--- a/docs/en/api-reference/peripherals/rmt.rst
+++ b/docs/en/api-reference/peripherals/rmt.rst
@@ -264,5 +264,5 @@ Application Examples
 API Reference
 -------------

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

--- a/docs/en/api-reference/peripherals/sdio_slave.rst
+++ b/docs/en/api-reference/peripherals/sdio_slave.rst
@@ -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
+

--- a/docs/en/api-reference/peripherals/sdmmc_host.rst
+++ b/docs/en/api-reference/peripherals/sdmmc_host.rst
@@ -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
--- a/docs/en/api-reference/peripherals/sdspi_host.rst
+++ b/docs/en/api-reference/peripherals/sdspi_host.rst
@@ -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
--- a/docs/en/api-reference/peripherals/sigmadelta.rst
+++ b/docs/en/api-reference/peripherals/sigmadelta.rst
@@ -29,4 +29,4 @@ Sigma-delta Modulation example: :example:`peripherals/sigmadelta`.
 API Reference
 -------------

-.. include:: /_build/inc/sigmadelta.inc
+.. include-build-file:: inc/sigmadelta.inc
--- a/docs/en/api-reference/peripherals/spi_master.rst
+++ b/docs/en/api-reference/peripherals/spi_master.rst
@@ -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

--- a/docs/en/api-reference/peripherals/spi_slave.rst
+++ b/docs/en/api-reference/peripherals/spi_slave.rst
@@ -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

--- a/docs/en/api-reference/peripherals/temp_sensor.rst
+++ b/docs/en/api-reference/peripherals/temp_sensor.rst
@@ -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
--- a/docs/en/api-reference/peripherals/timer.rst
+++ b/docs/en/api-reference/peripherals/timer.rst
@@ -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
--- a/docs/en/api-reference/peripherals/touch_pad.rst
+++ b/docs/en/api-reference/peripherals/touch_pad.rst
@@ -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
--- a/docs/en/api-reference/peripherals/uart.rst
+++ b/docs/en/api-reference/peripherals/uart.rst
@@ -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