esp-idf/docs/README.md

# Documentation Source Folder

This folder contains source files of **ESP-IDF documentation** available in [English](https://docs.espressif.com/projects/esp-idf/en/latest/) and [中文](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/).

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 build requirements Python 3 and running the wrapper `./build_docs.py` tool. Running `./build_docs.py --help` will give a summary of available options.

See [Documenting Code](https://docs.espressif.com/projects/esp-idf/en/latest/contribute/documenting-code.html) in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the `./build_docs.py` tool.
Replace all DOS line endings with Unix Command run was: git ls-tree -r HEAD --name-only \| xargs dos2unix 2018-07-04 19:01:03 -04:00			`# Documentation Source Folder`

			`This folder contains source files of ESP-IDF documentation available in [English](https://docs.espressif.com/projects/esp-idf/en/latest/) and [中文](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/).`

			`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.`

doc: Fix doc builds on Windows MINGW32, add some doc build documentation Using "find" doesn't work properly in MINGW32 Python, even if a MINGW32 find.exe is on the PATH... 2018-10-24 01:21:48 -04:00			`# Building Documentation`

docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-02-18 23:24:59 -05:00			The documentation build requirements Python 3 and running the wrapper `./build_docs.py` tool. Running `./build_docs.py --help` will give a summary of available options.
doc: Fix doc builds on Windows MINGW32, add some doc build documentation Using "find" doesn't work properly in MINGW32 Python, even if a MINGW32 find.exe is on the PATH... 2018-10-24 01:21:48 -04:00
docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-02-18 23:24:59 -05:00			See [Documenting Code](https://docs.espressif.com/projects/esp-idf/en/latest/contribute/documenting-code.html) in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the `./build_docs.py` tool.