zephyr
/
esp-idf
mirror of https://github.com/zephyrproject-rtos/esp-idf.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version

This commit is contained in:
krzychb 2018-02-03 22:12:13 +01:00
parent 12b4e416e6
commit c8d8cdbf38
10 changed files with 101 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
.gitignore vendored
View File

@ -26,15 +26,14 @@ examples/**/sdkconfig
examples/**/sdkconfig.old examples/**/sdkconfig.old
examples/**/build examples/**/build
#Doc build artifacts # Doc build artifacts
docs/_build/ docs/*/_build/
docs/doxygen-warning-log.txt docs/*/doxygen-warning-log.txt
docs/sphinx-warning-log.txt docs/*/sphinx-warning-log.txt
docs/sphinx-warning-log-sanitized.txt docs/*/sphinx-warning-log-sanitized.txt
docs/xml/ docs/*/xml/
docs/xml_in/ docs/*/xml_in/
docs/man/ docs/*/man/
docs/doxygen_sqlite3.db
# Unit test app files # Unit test app files
tools/unit-test-app/sdkconfig tools/unit-test-app/sdkconfig

2
README.md
View File

@ -96,7 +96,7 @@ The simplest way to use the partition table is to `make menuconfig` and choose o
In both cases the factory app is flashed at offset 0x10000. If you `make partition_table` then it will print a summary of the partition table. In both cases the factory app is flashed at offset 0x10000. If you `make partition_table` then it will print a summary of the partition table.
For more details about partition tables and how to create custom variations, view the [`docs/api-guides/partition-tables.rst`](docs/api-guides/partition-tables.rst) file. For more details about partition tables and how to create custom variations, view the [`docs/en/api-guides/partition-tables.rst`](docs/en/api-guides/partition-tables.rst) file.
## Erasing Flash ## Erasing Flash

168
docs/Doxyfile
View File

@ -24,146 +24,146 @@ INPUT = \
## ##
## Wi-Fi - API Reference ## Wi-Fi - API Reference
## ##
../components/esp32/include/esp_wifi.h \ ../../components/esp32/include/esp_wifi.h \
../components/esp32/include/esp_wifi_types.h \ ../../components/esp32/include/esp_wifi_types.h \
../components/esp32/include/esp_smartconfig.h \ ../../components/esp32/include/esp_smartconfig.h \
../components/esp32/include/esp_now.h \ ../../components/esp32/include/esp_now.h \
## Bluetooth - API Reference ## Bluetooth - API Reference
## Controller && VHCI ## Controller && VHCI
../components/bt/include/bt.h \ ../../components/bt/include/bt.h \
## Bluetooth COMMON ## Bluetooth COMMON
## Issue with __attribute__ ## Issue with __attribute__
../components/bt/bluedroid/api/include/esp_bt_defs.h \ ../../components/bt/bluedroid/api/include/esp_bt_defs.h \
../components/bt/bluedroid/api/include/esp_bt_main.h \ ../../components/bt/bluedroid/api/include/esp_bt_main.h \
../components/bt/bluedroid/api/include/esp_bt_device.h \ ../../components/bt/bluedroid/api/include/esp_bt_device.h \
## Bluetooth LE ## Bluetooth LE
../components/bt/bluedroid/api/include/esp_gap_ble_api.h \ ../../components/bt/bluedroid/api/include/esp_gap_ble_api.h \
## Issue with __attribute__ ## Issue with __attribute__
../components/bt/bluedroid/api/include/esp_gatt_defs.h \ ../../components/bt/bluedroid/api/include/esp_gatt_defs.h \
../components/bt/bluedroid/api/include/esp_gatts_api.h \ ../../components/bt/bluedroid/api/include/esp_gatts_api.h \
../components/bt/bluedroid/api/include/esp_gattc_api.h \ ../../components/bt/bluedroid/api/include/esp_gattc_api.h \
../components/bt/bluedroid/api/include/esp_blufi_api.h \ ../../components/bt/bluedroid/api/include/esp_blufi_api.h \
## Bluetooth Classic ## Bluetooth Classic
../components/bt/bluedroid/api/include/esp_gap_bt_api.h \ ../../components/bt/bluedroid/api/include/esp_gap_bt_api.h \
## Issue with __attribute__ ## Issue with __attribute__
../components/bt/bluedroid/api/include/esp_a2dp_api.h \ ../../components/bt/bluedroid/api/include/esp_a2dp_api.h \
../components/bt/bluedroid/api/include/esp_avrc_api.h \ ../../components/bt/bluedroid/api/include/esp_avrc_api.h \
../components/bt/bluedroid/api/include/esp_spp_api.h \ ../../components/bt/bluedroid/api/include/esp_spp_api.h \
## ##
## Ethernet - API Reference ## Ethernet - API Reference
## ##
../components/ethernet/include/esp_eth.h \ ../../components/ethernet/include/esp_eth.h \
../components/ethernet/include/eth_phy/phy.h \ ../../components/ethernet/include/eth_phy/phy.h \
../components/ethernet/include/eth_phy/phy_tlk110.h \ ../../components/ethernet/include/eth_phy/phy_tlk110.h \
../components/ethernet/include/eth_phy/phy_lan8720.h \ ../../components/ethernet/include/eth_phy/phy_lan8720.h \
## ##
## Peripherals - API Reference ## Peripherals - API Reference
## ##
../components/driver/include/driver/adc.h \ ../../components/driver/include/driver/adc.h \
../components/driver/include/driver/dac.h \ ../../components/driver/include/driver/dac.h \
../components/driver/include/driver/gpio.h \ ../../components/driver/include/driver/gpio.h \
../components/driver/include/driver/rtc_io.h \ ../../components/driver/include/driver/rtc_io.h \
../components/driver/include/driver/i2c.h \ ../../components/driver/include/driver/i2c.h \
../components/driver/include/driver/i2s.h \ ../../components/driver/include/driver/i2s.h \
../components/driver/include/driver/ledc.h \ ../../components/driver/include/driver/ledc.h \
../components/driver/include/driver/mcpwm.h \ ../../components/driver/include/driver/mcpwm.h \
../components/driver/include/driver/pcnt.h \ ../../components/driver/include/driver/pcnt.h \
../components/driver/include/driver/rmt.h \ ../../components/driver/include/driver/rmt.h \
../components/driver/include/driver/sigmadelta.h \ ../../components/driver/include/driver/sigmadelta.h \
../components/driver/include/driver/spi_common.h \ ../../components/driver/include/driver/spi_common.h \
../components/driver/include/driver/spi_master.h \ ../../components/driver/include/driver/spi_master.h \
../components/driver/include/driver/spi_slave.h \ ../../components/driver/include/driver/spi_slave.h \
../components/driver/include/driver/timer.h \ ../../components/driver/include/driver/timer.h \
../components/driver/include/driver/touch_pad.h \ ../../components/driver/include/driver/touch_pad.h \
../components/driver/include/driver/uart.h \ ../../components/driver/include/driver/uart.h \
../components/esp_adc_cal/include/esp_adc_cal.h \ ../../components/esp_adc_cal/include/esp_adc_cal.h \
../components/soc/esp32/include/soc/adc_channel.h \ ../../components/soc/esp32/include/soc/adc_channel.h \
../components/soc/esp32/include/soc/dac_channel.h \ ../../components/soc/esp32/include/soc/dac_channel.h \
../components/soc/esp32/include/soc/touch_channel.h \ ../../components/soc/esp32/include/soc/touch_channel.h \
../components/soc/esp32/include/soc/uart_channel.h \ ../../components/soc/esp32/include/soc/uart_channel.h \
../components/soc/esp32/include/soc/rtc_gpio_channel.h \ ../../components/soc/esp32/include/soc/rtc_gpio_channel.h \
## ##
## Protocols - API Reference ## Protocols - API Reference
## ##
../components/mdns/include/mdns.h \ ../../components/mdns/include/mdns.h \
## ##
## Storage - API Reference ## Storage - API Reference
## ##
## SPI Flash and Partition APIs ## SPI Flash and Partition APIs
../components/spi_flash/include/esp_spi_flash.h \ ../../components/spi_flash/include/esp_spi_flash.h \
../components/spi_flash/include/esp_partition.h \ ../../components/spi_flash/include/esp_partition.h \
../components/bootloader_support/include/esp_flash_encrypt.h \ ../../components/bootloader_support/include/esp_flash_encrypt.h \
## SPIFFS ## SPIFFS
../components/spiffs/include/esp_spiffs.h \ ../../components/spiffs/include/esp_spiffs.h \
## SD/MMC Card Host ## SD/MMC Card Host
## NOTE: for three lines below header_file.inc is not used ## NOTE: for three lines below header_file.inc is not used
../components/sdmmc/include/sdmmc_cmd.h \ ../../components/sdmmc/include/sdmmc_cmd.h \
../components/driver/include/driver/sdmmc_host.h \ ../../components/driver/include/driver/sdmmc_host.h \
../components/driver/include/driver/sdmmc_types.h \ ../../components/driver/include/driver/sdmmc_types.h \
../components/driver/include/driver/sdspi_host.h \ ../../components/driver/include/driver/sdspi_host.h \
## Non-Volatile Storage ## Non-Volatile Storage
../components/nvs_flash/include/nvs.h \ ../../components/nvs_flash/include/nvs.h \
../components/nvs_flash/include/nvs_flash.h \ ../../components/nvs_flash/include/nvs_flash.h \
## Virtual Filesystem ## Virtual Filesystem
../components/vfs/include/esp_vfs.h \ ../../components/vfs/include/esp_vfs.h \
../components/vfs/include/esp_vfs_dev.h \ ../../components/vfs/include/esp_vfs_dev.h \
## FAT Filesystem ## FAT Filesystem
## NOTE: for two lines below header_file.inc is not used ## NOTE: for two lines below header_file.inc is not used
../components/fatfs/src/esp_vfs_fat.h \ ../../components/fatfs/src/esp_vfs_fat.h \
../components/fatfs/src/diskio.h \ ../../components/fatfs/src/diskio.h \
## Wear Levelling ## Wear Levelling
../components/wear_levelling/include/wear_levelling.h \ ../../components/wear_levelling/include/wear_levelling.h \
## ##
## System - API Reference ## System - API Reference
## ##
## Memory Allocation # ## Memory Allocation #
../components/heap/include/esp_heap_caps.h \ ../../components/heap/include/esp_heap_caps.h \
../components/heap/include/esp_heap_trace.h \ ../../components/heap/include/esp_heap_trace.h \
../components/heap/include/esp_heap_caps_init.h \ ../../components/heap/include/esp_heap_caps_init.h \
../components/heap/include/multi_heap.h \ ../../components/heap/include/multi_heap.h \
## Interrupt Allocation ## Interrupt Allocation
../components/esp32/include/esp_intr_alloc.h \ ../../components/esp32/include/esp_intr_alloc.h \
## Watchdogs ## Watchdogs
## NOTE: for two lines below header_file.inc is not used ## NOTE: for two lines below header_file.inc is not used
../components/esp32/include/esp_int_wdt.h \ ../../components/esp32/include/esp_int_wdt.h \
../components/esp32/include/esp_task_wdt.h \ ../../components/esp32/include/esp_task_wdt.h \
## Hooks ## Hooks
../components/esp32/include/esp_freertos_hooks.h \ ../../components/esp32/include/esp_freertos_hooks.h \
## Inter-Processor Call ## Inter-Processor Call
../components/esp32/include/esp_ipc.h \ ../../components/esp32/include/esp_ipc.h \
## Over The Air Updates (OTA) ## Over The Air Updates (OTA)
../components/app_update/include/esp_ota_ops.h \ ../../components/app_update/include/esp_ota_ops.h \
## Sleep ## Sleep
## NOTE: for line below header_file.inc is not used ## NOTE: for line below header_file.inc is not used
../components/esp32/include/esp_sleep.h \ ../../components/esp32/include/esp_sleep.h \
## Logging ## Logging
../components/log/include/esp_log.h \ ../../components/log/include/esp_log.h \
## Base MAC address ## Base MAC address
## NOTE: for line below header_file.inc is not used ## NOTE: for line below header_file.inc is not used
../components/esp32/include/esp_system.h \ ../../components/esp32/include/esp_system.h \
## ##
## ULP Coprocessor - API Guides ## ULP Coprocessor - API Guides
## ##
## NOTE: for line below header_file.inc is not used ## NOTE: for line below header_file.inc is not used
../components/ulp/include/esp32/ulp.h \ ../../components/ulp/include/esp32/ulp.h \
## ##
## Application Level Tracing - API Reference ## Application Level Tracing - API Reference
## ##
../components/app_trace/include/esp_app_trace.h \ ../../components/app_trace/include/esp_app_trace.h \
### Power management ### Power management
../components/esp32/include/esp_pm.h \ ../../components/esp32/include/esp_pm.h \
../components/esp32/include/esp32/pm.h \ ../../components/esp32/include/esp32/pm.h \
### esp_timer, High Resolution Timer ### esp_timer, High Resolution Timer
../components/esp32/include/esp_timer.h \ ../../components/esp32/include/esp_timer.h \
### ###
### FreeRTOS ### FreeRTOS
### ###
../components/freertos/include/freertos/task.h \ ../../components/freertos/include/freertos/task.h \
../components/freertos/include/freertos/queue.h \ ../../components/freertos/include/freertos/queue.h \
../components/freertos/include/freertos/semphr.h \ ../../components/freertos/include/freertos/semphr.h \
../components/freertos/include/freertos/timers.h \ ../../components/freertos/include/freertos/timers.h \
../components/freertos/include/freertos/event_groups.h \ ../../components/freertos/include/freertos/event_groups.h \
../components/freertos/include/freertos/ringbuf.h ../../components/freertos/include/freertos/ringbuf.h

2
docs/api-guides/ulp_macros.rst
View File

@ -1 +1 @@
.. include:: ../../components/ulp/README.rst .. include:: ../../../components/ulp/README.rst

2
docs/api-reference/storage/nvs_flash.rst
View File

@ -1,4 +1,4 @@
.. include:: ../../../components/nvs_flash/README.rst .. include:: ../../../../components/nvs_flash/README.rst
Application Example Application Example
------------------- -------------------

2
docs/api-reference/storage/spi_flash.rst
View File

@ -1,4 +1,4 @@
.. include:: ../../../components/spi_flash/README.rst .. include:: ../../../../components/spi_flash/README.rst
See also See also
-------- --------

4
docs/api-reference/storage/vfs.rst
View File

@ -1,11 +1,11 @@
.. include:: ../../../components/vfs/README.rst .. include:: ../../../../components/vfs/README.rst
Application Example Application Example
------------------- -------------------
`Instructions`_ `Instructions`_
.. _Instructions: ../template.html .. _Instructions: ../../template.html
API Reference API Reference
------------- -------------

2
docs/api-reference/storage/wear-levelling.rst
View File

@ -1,4 +1,4 @@
.. include:: ../../../components/wear_levelling/README.rst .. include:: ../../../../components/wear_levelling/README.rst
See also See also
-------- --------

2
docs/api-reference/system/log.rst
View File

@ -1,4 +1,4 @@
.. include:: ../../../components/log/README.rst .. include:: ../../../../components/log/README.rst
Application Example Application Example
------------------- -------------------

2
docs/contribute/index.rst
View File

@ -1 +1 @@
.. include:: ../../CONTRIBUTING.rst .. include:: ../../../CONTRIBUTING.rst