From 716a3aebebe9ada64a13d5cf8021a1a1e2a97984 Mon Sep 17 00:00:00 2001 From: Dong Heng Date: Tue, 29 Jan 2019 20:04:47 +0800 Subject: [PATCH] docs(script): Add new docs to script --- docs/Doxyfile | 5 ++++- docs/en/api-guides/index.rst | 3 +++ docs/en/api-reference/peripherals/adc.rst | 7 +++++++ docs/en/api-reference/peripherals/hw_timer.rst | 7 +++++++ docs/en/api-reference/peripherals/index.rst | 3 +++ docs/en/api-reference/peripherals/spi.rst | 7 +++++++ 6 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 docs/en/api-reference/peripherals/adc.rst create mode 100644 docs/en/api-reference/peripherals/hw_timer.rst create mode 100644 docs/en/api-reference/peripherals/spi.rst diff --git a/docs/Doxyfile b/docs/Doxyfile index 1262877d..4c503d3b 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -52,7 +52,10 @@ INPUT = \ ../../components/esp8266/include/driver/gpio.h \ ../../components/esp8266/include/driver/i2c.h \ ../../components/esp8266/include/driver/pwm.h \ - ../../components/esp8266/include/driver/uart.h + ../../components/esp8266/include/driver/uart.h \ + ../../components/esp8266/include/driver/adc.h \ + ../../components/esp8266/include/driver/spi.h \ + ../../components/esp8266/include/driver/hw_timer.h ## ## Get warnings for functions that have no documentation for their parameters or return value diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index 332d9502..a65df392 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -6,3 +6,6 @@ API Guides Build System Partition Tables + System Task + PWM and Sniffer Coexists + FOTA from an Old SDK to the New ESP8266 RTOS SDK (IDF Style) diff --git a/docs/en/api-reference/peripherals/adc.rst b/docs/en/api-reference/peripherals/adc.rst new file mode 100644 index 00000000..3f69faec --- /dev/null +++ b/docs/en/api-reference/peripherals/adc.rst @@ -0,0 +1,7 @@ +ADC +=== + +API Reference +------------- + +.. include:: /_build/inc/adc.inc \ No newline at end of file diff --git a/docs/en/api-reference/peripherals/hw_timer.rst b/docs/en/api-reference/peripherals/hw_timer.rst new file mode 100644 index 00000000..50f2a9ec --- /dev/null +++ b/docs/en/api-reference/peripherals/hw_timer.rst @@ -0,0 +1,7 @@ +Hardware Timer +============== + +API Reference +------------- + +.. include:: /_build/inc/hw_timer.inc \ No newline at end of file diff --git a/docs/en/api-reference/peripherals/index.rst b/docs/en/api-reference/peripherals/index.rst index 7b5d157f..0c75709a 100644 --- a/docs/en/api-reference/peripherals/index.rst +++ b/docs/en/api-reference/peripherals/index.rst @@ -6,8 +6,11 @@ Peripherals API GPIO I2C + SPI PWM UART + ADC + Hardware Timer Example code for this API section is provided in :example:`peripherals` directory of ESP-IDF examples. diff --git a/docs/en/api-reference/peripherals/spi.rst b/docs/en/api-reference/peripherals/spi.rst new file mode 100644 index 00000000..23519a9b --- /dev/null +++ b/docs/en/api-reference/peripherals/spi.rst @@ -0,0 +1,7 @@ +SPI +=== + +API Reference +------------- + +.. include:: /_build/inc/spi.inc \ No newline at end of file