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

2025-09-22 09:01:08 +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/protocols/esp_http_client.rst
+++ b/docs/en/api-reference/protocols/esp_http_client.rst
@@ -188,4 +188,4 @@ HTTP Client example: :example:`protocols/esp_http_client`.
 API Reference
 -------------

-.. include:: /_build/inc/esp_http_client.inc
+.. include-build-file:: inc/esp_http_client.inc
--- a/docs/en/api-reference/protocols/esp_http_server.rst
+++ b/docs/en/api-reference/protocols/esp_http_server.rst
@@ -155,4 +155,4 @@ Check the example under :example:`protocols/http_server/persistent_sockets`.
 API Reference
 -------------

-.. include:: /_build/inc/esp_http_server.inc
+.. include-build-file:: inc/esp_http_server.inc
--- a/docs/en/api-reference/protocols/esp_https_server.rst
+++ b/docs/en/api-reference/protocols/esp_https_server.rst
@@ -47,4 +47,4 @@ The initial session setup can take about two seconds, or more with slower clock
 API Reference
 -------------

-.. include:: /_build/inc/esp_https_server.inc
+.. include-build-file:: inc/esp_https_server.inc
--- a/docs/en/api-reference/protocols/esp_local_ctrl.rst
+++ b/docs/en/api-reference/protocols/esp_local_ctrl.rst
@@ -203,4 +203,4 @@ The various protocomm endpoints provided by **esp_local_ctrl** are listed below:
 API Reference
 -------------

-.. include:: /_build/inc/esp_local_ctrl.inc
+.. include-build-file:: inc/esp_local_ctrl.inc
--- a/docs/en/api-reference/protocols/esp_serial_slave_link.rst
+++ b/docs/en/api-reference/protocols/esp_serial_slave_link.rst
@@ -150,5 +150,5 @@ Please refer to the specific example README.md for details.
 API Reference
 -------------

-.. include:: /_build/inc/essl.inc
-.. include:: /_build/inc/essl_sdio.inc
+.. include-build-file:: inc/essl.inc
+.. include-build-file:: inc/essl_sdio.inc
--- a/docs/en/api-reference/protocols/esp_tls.rst
+++ b/docs/en/api-reference/protocols/esp_tls.rst
@@ -91,4 +91,4 @@ SSL/TLS libraries and with all respective configurations set to default.
 API Reference
 -------------

-.. include:: /_build/inc/esp_tls.inc
+.. include-build-file:: inc/esp_tls.inc
--- a/docs/en/api-reference/protocols/esp_websocket_client.rst
+++ b/docs/en/api-reference/protocols/esp_websocket_client.rst
@@ -66,5 +66,5 @@ Simple WebSocket example that uses esp_websocket_client to establish a websocket
 API Reference
 -------------

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

--- a/docs/en/api-reference/protocols/icmp_echo.rst
+++ b/docs/en/api-reference/protocols/icmp_echo.rst
@@ -117,6 +117,6 @@ ICMP echo example: :example:`protocols/icmp_echo`
 API Reference
 -------------

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


--- a/docs/en/api-reference/protocols/mdns.rst
+++ b/docs/en/api-reference/protocols/mdns.rst
@@ -184,6 +184,6 @@ mDNS server/scanner example: :example:`protocols/mdns`.
 API Reference
 -------------

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


--- a/docs/en/api-reference/protocols/mqtt.rst
+++ b/docs/en/api-reference/protocols/mqtt.rst
@@ -158,4 +158,4 @@ The following events may be posted by the MQTT client:
 API Reference
 -------------

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