Skip to content

Commit f184c8b

Browse files
committed
Merge branch 'docs/add_new_docs_to_script_v3.1' into 'release/v3.1'
Add new docs to script (backport v3.1) See merge request sdk/ESP8266_RTOS_SDK!749
2 parents 26127f2 + 39b1476 commit f184c8b

File tree

6 files changed

+31
-1
lines changed

6 files changed

+31
-1
lines changed

docs/Doxyfile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,10 @@ INPUT = \
5252
../../components/esp8266/include/driver/gpio.h \
5353
../../components/esp8266/include/driver/i2c.h \
5454
../../components/esp8266/include/driver/pwm.h \
55-
../../components/esp8266/include/driver/uart.h
55+
../../components/esp8266/include/driver/uart.h \
56+
../../components/esp8266/include/driver/adc.h \
57+
../../components/esp8266/include/driver/spi.h \
58+
../../components/esp8266/include/driver/hw_timer.h
5659
##
5760

5861
## Get warnings for functions that have no documentation for their parameters or return value

docs/en/api-guides/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ API Guides
66

77
Build System <build-system>
88
Partition Tables <partition-tables>
9+
System Task <system-tasks>
10+
PWM and Sniffer Coexists <pwm-and-sniffer-coexists>
11+
FOTA from an Old SDK to the New ESP8266 RTOS SDK (IDF Style) <fota-from-old-new>
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ADC
2+
===
3+
4+
API Reference
5+
-------------
6+
7+
.. include:: /_build/inc/adc.inc
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Hardware Timer
2+
==============
3+
4+
API Reference
5+
-------------
6+
7+
.. include:: /_build/inc/hw_timer.inc

docs/en/api-reference/peripherals/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ Peripherals API
66

77
GPIO <gpio>
88
I2C <i2c>
9+
SPI <spi>
910
PWM <pwm>
1011
UART <uart>
12+
ADC <adc>
13+
Hardware Timer <hw_timer>
1114

1215
Example code for this API section is provided in :example:`peripherals` directory of ESP-IDF examples.
1316

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
SPI
2+
===
3+
4+
API Reference
5+
-------------
6+
7+
.. include:: /_build/inc/spi.inc

0 commit comments

Comments
 (0)