30c2fca25a
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 |
||
|---|---|---|
| .. | ||
| _static | ||
| api | ||
| security | ||
| build-system.rst | ||
| conf.py | ||
| contributing.rst | ||
| contributor-agreement.rst | ||
| COPYRIGHT.rst | ||
| core_dump.rst | ||
| deep-sleep-stub.rst | ||
| documenting-code.rst | ||
| Doxyfile | ||
| doxygen_xml_to_rst.xslt | ||
| eclipse-setup.rst | ||
| esp32.cfg | ||
| general-notes.rst | ||
| index.rst | ||
| linux-setup.rst | ||
| macos-setup.rst | ||
| make-project.rst | ||
| Makefile | ||
| openocd.rst | ||
| partition-tables.rst | ||
| README.md | ||
| requirements.txt | ||
| style-guide.rst | ||
| ulp.rst | ||
| unit-tests.rst | ||
| windows-setup.rst | ||
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:
- Main server: http://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/
- Mirror: https://dl.espressif.com/doc/esp-idf/latest/