mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
908dbe0595
* Better comment of nvs_get_used_entry_count() * Mention C++ example in API reference * WIP: Used target instead of hard code ESP32 * Note that strings can only span one page * Reflect that item types have been moved * Some clarification about nvs_commit() * Improved reference to the ESP Partition API * fixed little mistake in documenting-code.rst * Change of nvs_open_from_part() to nvs_open_from_partition() reflected in docs * Corrected documentation of NVSHandle::get_string(), NVSHandle::get_blob() and NVSHandle::get_item_size(). * Closes IDF-1563 * Closes IDF-859 * Closes https://github.com/espressif/esp-idf/issues/6123 |
||
---|---|---|
.. | ||
_static | ||
en | ||
latex_templates | ||
zh_CN | ||
check_doc_warnings.sh | ||
check_lang_folder_sync.sh | ||
conf_common.py | ||
docs_common.mk | ||
Doxyfile | ||
gen-dxd.py | ||
gen-toolchain-links.py | ||
gen-version-specific-includes.py | ||
get_github_rev.py | ||
html_redirects.py | ||
latex_builder.py | ||
link-roles.py | ||
local_util.py | ||
page_redirects.txt | ||
README.md | ||
requirements.txt | ||
sanitize_version.py | ||
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
- Install
make
anddoxygen
for your platform (make
may already be installed as an ESP-IDF prerequisite). - Change to either the docs/en or docs/zh_CN subdirectory and run
make html
make
will probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-runmake html
to build the docs.
For MSYS2 MINGW32 on Windows
If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:
pacman -S doxygen mingw-w64-i686-python2-pillow
Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.