blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-12 10:39:11 -04:00
Code Issues Projects Releases Wiki Activity
esp-idf/docs
History
Ivan Grokhotkov 8911e666a0 Merge branch 'feature/docs_partition_ota_flash' into 'master' 
Partition/SPI/OTA docs & OTA new functionality

* Update partition, SPI flash & OTA docs to reflect functionality changes
* Refactor OTA implementation to perform checks mentioned in API doc
* Add new functions to OTA API: esp_ota_get_running_partition() & esp_ota_get_next_update_partition() functions
* Add spi_flash_cache2phys() & spi_flash_phys2cache() functions to support esp_ota_get_running_partition()


See merge request !513
2017-03-03 11:27:01 +08:00
..
_static
doc: Documenting Code clean up
2016-11-21 10:24:12 +08:00
api
Merge branch 'feature/docs_partition_ota_flash' into 'master'
2017-03-03 11:27:01 +08:00
security
flash encryption/secure boot: Restructure documentation
2017-02-15 09:42:46 +11:00
build-system.rst
Build system: Add new BATCH_BUILD flag to disable interactive parts of the build
2017-02-22 11:59:37 +11:00
conf.py
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00
contributing.rst
Link to file a folder up
2016-11-01 01:20:04 +08:00
contributor-agreement.rst
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00
COPYRIGHT.rst
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00
core_dump.rst
esp32: Fixed and updated core dump docs
2017-01-26 18:47:10 +03:00
deep-sleep-stub.rst
Fixed section header style
2016-11-05 17:06:55 +01:00
documenting-code.rst
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00
Doxyfile
flash encryption/secure boot: Restructure documentation
2017-02-15 09:42:46 +11:00
doxygen_xml_to_rst.xslt
rmt: add documentation
2016-11-22 01:44:23 +08:00
eclipse-setup-windows.rst
Build system: Add new BATCH_BUILD flag to disable interactive parts of the build
2017-02-22 11:59:37 +11:00
eclipse-setup.rst
Build system: Add new BATCH_BUILD flag to disable interactive parts of the build
2017-02-22 11:59:37 +11:00
esp32.cfg
Fix issued raised in the merge request
2016-08-30 11:30:03 +08:00
general-notes.rst
docs: Improve/clarify partition, OTA & SPI flash docs
2017-02-20 15:31:42 +11:00
index.rst
Docs: Mark PDF links as such in the documentation index
2017-02-15 09:42:46 +11:00
link-roles.py
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00
linux-setup.rst
docs: update toolchain version
2017-01-11 15:03:14 +08:00
macos-setup.rst
docs: fix macOS setup instructions
2017-01-16 02:38:31 +08:00
make-project.rst
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00
Makefile
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00
openocd.rst
Simplified "Installing OpenOCD" with git clone --recursive
2016-11-17 10:19:42 +11:00
partition-tables.rst
docs: Improve/clarify partition, OTA & SPI flash docs
2017-02-20 15:31:42 +11:00
README.md
Docs folder info, ref. https://github.com/espressif/esp-idf/issues/243; Doc title fix
2017-01-17 20:37:27 +01:00
repo_util.py
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00
requirements.txt
docs: fix typos, build docs with gitlab CI
2016-11-01 20:08:29 +08:00
style-guide.rst
Fixed link so it can render by Sphinx
2016-11-10 22:44:59 +01:00
ulp.rst
Updated relative paths to included documents
2017-01-16 23:08:35 +01:00
unit-tests.rst
esp32: add unit testing doc
2017-01-18 17:08:20 +08:00
windows-setup.rst
docs: use custom roles to generate GitHub links
2017-01-20 17:22:47 +08:00

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated instantly on each commit: