Chapter 6. Contributions Guide
3. To distinguish between sections, use the following heading levels:
• # with overline, for parts
• * with overline, for chapters
• =, for sections
• -, for subsections
• ^, for subsubsections
• ", for paragraphs
Application Example
Note: INSTRUCTIONS
1. Prepare one or more practical examples to demonstrate functionality of this API.
2. Each example should follow pattern of projects located in esp-idf/examples/ folder.
3. Place example in this folder complete with README.md file.
4. Provide overview of demonstrated functionality in README.md.
5. With good overview reader should be able to understand what example does without opening the source code.
6. Depending on complexity of example, break down description of code into parts and provide overview of
functionality of each part.
7. Include flow diagram and screenshots of application output if applicable.
8. Finally add in this section synopsis of each example together with link to respective folder in esp-idf/
examples/.
API Reference
Note: INSTRUCTIONS
1. This repository provides for automatic update of API reference documentation using code markup retrieved by
Doxygen from header files.
1. Update is done on each documentation build by invoking Sphinx extension :esp_extensions/run_doxygen.py for
all header files listed in the INPUT statement of docs/doxygen/Doxyfile.
1. Each line of the INPUT statement (other than a comment that begins with ##) contains a path to header file
*.h that will be used to generate corresponding *.inc files:
##
## Wi-Fi - API Reference
##
../components/esp32/include/esp_wifi.h \
../components/esp32/include/esp_smartconfig.h \
1. When the headers are expanded, any macros defined by default in sdkconfig.h as well as any macros
defined in SOC-specific include/soc/*_caps.h headers will be expanded. This allows the headers to
include/exclude material based on the IDF_TARGET value.
1. The *.inc files contain formatted reference of API members generated automatically on each documen-
tation build. All *.inc files are placed in Sphinx _build directory. To see directives generated for e.g.
esp_wifi.h, run python gen-dxd.py esp32/include/esp_wifi.h.
1. To show contents of *.inc file in documentation, include it as follows:
.. include-build-file:: inc/esp_wifi.inc
For example see docs/en/api-reference/network/esp_wifi.rst
Espressif Systems 1583
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General