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
esp-idf/docs
History
Ivan Grokhotkov 30c2fca25a Merge branch 'bugfix/docs_cleanup' into 'master' 
Organize examples and API documentation - supplement to !430

This supplement to !430, both intended to replace bulky  !421.

1. Fixed broken links
2. Added links to available examples in API documentation, where missing
3. Updated links to point directly to example folder (to show README.md with example description)
4. Added README.md in docs folder info to point reader to ReadTheDocs instead of doc sources, ref. https://github.com/espressif/esp-idf/issues/243
5. Fixed some typo errors / Sphinx warnings
6. Fixed memory leak in example, ref. https://github.com/espressif/esp-idf/issues/209


See merge request !440
2017-01-19 00:33:31 +08:00
..
_static
doc: Documenting Code clean up
2016-11-21 10:24:12 +08:00
api
Typo corrections
2017-01-17 21:12:54 +01:00
security
Typo corrections
2017-01-17 21:12:54 +01:00
build-system.rst
Typo corrections
2017-01-17 21:12:54 +01:00
conf.py
Docs folder info, ref. https://github.com/espressif/esp-idf/issues/243; Doc title fix
2017-01-17 20:37:27 +01:00
contributing.rst
Link to file a folder up
2016-11-01 01:20:04 +08:00
contributor-agreement.rst
Fixed broken links
2016-11-05 17:04:35 +01:00
COPYRIGHT.rst
Initial list of Wi-Fi API
2016-11-01 01:20:04 +08:00
core_dump.rst
esp32: Fixes issues discussed during code review of MR!341
2017-01-12 19:38:19 +03:00
deep-sleep-stub.rst
Fixed section header style
2016-11-05 17:06:55 +01:00
documenting-code.rst
doc: Documenting Code clean up
2016-11-21 10:24:12 +08:00
Doxyfile
Initial mDNS component and example
2017-01-13 12:12:43 +02:00
doxygen_xml_to_rst.xslt
rmt: add documentation
2016-11-22 01:44:23 +08:00
eclipse-setup.rst
docs: fix typos, build docs with gitlab CI
2016-11-01 20:08:29 +08:00
esp32.cfg
Fix issued raised in the merge request
2016-08-30 11:30:03 +08:00
general-notes.rst
docs: fix data RAM size
2017-01-17 01:18:23 +08:00
index.rst
Merge branch 'bugfix/docs_cleanup' into 'master'
2017-01-19 00:33:31 +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
Make section
2016-11-01 01:20:04 +08:00
Makefile
Initial Sphinx / ReadTheDocs.org configuration
2016-11-01 01:20:04 +08:00
openocd.rst
Simplified "Installing OpenOCD" with git clone --recursive
2016-11-17 10:19:42 +11:00
partition-tables.rst
Build system: Add make erase_flash target
2016-12-20 10:00:04 +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
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: update toolchain version
2017-01-11 15:03:14 +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: