Angus Gratton
4636e8a34c
docs/documenting-code: Add a couple of follow up notes on top of last commit
|
6 лет назад | |
|---|---|---|
| .. | ||
| _static | 6 лет назад | |
| en | 6 лет назад | |
| extensions | 6 лет назад | |
| idf_extensions | 6 лет назад | |
| zh_CN | 6 лет назад | |
| Doxyfile | 6 лет назад | |
| README.md | 7 лет назад | |
| TEMPLATE_EXAMPLE_README.md | 6 лет назад | |
| build_docs.py | 6 лет назад | |
| check_lang_folder_sync.sh | 7 лет назад | |
| conf_common.py | 6 лет назад | |
| doxygen-known-warnings.txt | 6 лет назад | |
| page_redirects.txt | 6 лет назад | |
| requirements.txt | 6 лет назад | |
| sphinx-known-warnings.txt | 6 лет назад | |
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
makeanddoxygenfor your platform (makemay already be installed as an ESP-IDF prerequisite). - Change to either the docs/en or docs/zh_CN subdirectory and run
make html makewill 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 htmlto 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.