mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
e08cde2c89
Setting OUTPUT_FORMAT through the CMake variable probably never functioned and seems to be a remnant (possibly a typo in the documentation) from the time when the -DOUTPUT_JSON=1 CMake variable was used to specify the JSON output format, prior to the introduction of the --format option. This removes the note regarding the option to choose the output format using -DOUTPUT_FORMAT. Closes https://github.com/espressif/esp-idf/issues/14383 Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com> |
||
|---|---|---|
| .. | ||
| _static | ||
| docs_not_updated | ||
| doxygen | ||
| en | ||
| zh_CN | ||
| check_lang_folder_sync.sh | ||
| conf_common.py | ||
| doxygen-known-warnings.txt | ||
| page_redirects.txt | ||
| README.md | ||
| sphinx-known-warnings.txt | ||
| TEMPLATE_EXAMPLE_README.md | ||
Documentation Source Folder
This folder contains source files of ESP-IDF documentation available in English and 中文.
The sources do not render well in GitHub and some information is not visible at all.
Use actual documentation generated within about 20 minutes on each commit:
Hosted Documentation
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
Building Documentation
The documentation is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md