alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
01a11b2d0e
esp-idf/docs
History
Zim Kalinowski 6d876a8677 Merge branch 'bugfix/read_ota_partition_required_output_arg_v4.1' into 'release/v4.1' 
otatool: Fixes read_ota_partition cmd, required output arg (v4.1)

See merge request espressif/esp-idf!13674
2021-08-12 21:30:20 +00:00
..
_static docs: update Windows Tools 2.9 installation 2021-06-30 12:47:51 +02:00
en Merge branch 'bugfix/read_ota_partition_required_output_arg_v4.1' into 'release/v4.1' 2021-08-12 21:30:20 +00:00
latex_templates docs: self host docs 2020-11-24 02:16:02 +00:00
zh_CN Merge branch 'bugfix/read_ota_partition_required_output_arg_v4.1' into 'release/v4.1' 2021-08-12 21:30:20 +00:00
check_doc_warnings.sh docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs. 2019-02-27 22:11:59 +01:00
check_lang_folder_sync.sh Revert "docs: Temporarily allow cmake docs to be in English only" 2018-05-07 18:45:49 +08:00
conf_common.py docs: self host docs 2020-11-24 02:16:02 +00:00
docs_common.mk docs: Update Versions file in line with the latest Support Policy document 2020-09-25 10:12:56 +10:00
Doxyfile docs: fix doxygen compile warnings for doxygen 1.9.1 2021-04-12 08:44:06 +08:00
gen-dxd.py docs: Correct Python coding style 2018-12-05 08:22:33 +01:00
gen-toolchain-links.py Introduce esp-2019r2 toolchain for both ESP32 and ESP32s2 targets 2019-11-04 16:14:57 +07:00
gen-version-specific-includes.py docs: self host docs 2020-11-24 02:16:02 +00:00
get_github_rev.py docs: self host docs 2020-11-24 02:16:02 +00:00
html_redirects.py docs: Add option to redirect documentation pages which have moved 2018-12-18 14:07:43 +11:00
latex_builder.py docs: self host docs 2020-11-24 02:16:02 +00:00
link-roles.py docs: fix "link to translation" being broken 2021-03-10 18:55:43 +08:00
local_util.py Download font file only is not exists in target location 2019-05-21 09:51:39 +08:00
page_redirects.txt feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 2020-03-06 01:16:04 +05:30
README.md doc: Fix doc builds on Windows MINGW32, add some doc build documentation 2018-10-26 04:04:56 +00:00
requirements.txt docs: self host docs 2020-11-24 02:16:02 +00:00
sanitize_version.py docs: self host docs 2020-11-24 02:16:02 +00:00
sphinx-known-warnings.txt doc: Remove duplicate ulp-cmake 2020-01-10 16:38:06 +11:00
TEMPLATE_EXAMPLE_README.md examples: Update system examples README 2019-08-28 16:19:40 +08:00

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

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 and doxygen 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-run make 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.