eb5fd63965
Document the create --format option (SPDX 2.2 tag/value and JSON, SPDX 3.0.1 JSON-LD, and CycloneDX 1.6) and the new --file option on idf.py sbom-create and sbom-check, and generalize the previously SPDX-only wording. Note the NVDAPIKEY variable for faster online scans, document that sbom-check exits with a non-zero status when vulnerabilities are found, drop an unused link target, and update the SBOM reference link. Fix the section heading levels to follow the esp-docs conventions.
Documentation Source Folder
This folder contains source files of ESP-IDF documentation available in English and Chinese.
The sources do not render well in GitHub and some information is not visible without building the documentation.
Use the actual documentation, which is generated within about 20 minutes of each commit:
Hosted Documentation
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- Chinese: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
After clicking any link to ESP-IDF Programming Guide, go to the top of the sidebar, then make sure you have the correct Espressif chip (target) and ESP-IDF version selected in the dropdown menus. You can also find a link at the bottom right to download the HTML version as a zip for offline reading.
Building Documentation
The documentation is built using the Python package esp-docs, which can be installed by running:
pip install esp-docs
For a summary of available options, run:
build-docs --help
For more information, see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md