Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-10-02 11:10:54 +03:00
Code Issues Packages Projects Releases Wiki Activity
46,400 Commits 25 Branches 192 Tags
32895539f2f961673094de4c92812fe0571fb142
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Krzysztof 70d565ddbb change(docs): Enable Documentation Chatbot only for the master branch 2025-04-29 20:26:14 +08:00
Krzysztof 290ca75ae0 [docs] Update API Reference of SPI Flash for AR2023-003 2023-08-27 18:31:31 +08:00
Krzysztof d552d61abf docs(jtag): Update CN translation of 'api-guides/jtag-debugging/index.rst' 2023-07-04 12:28:12 +08:00
Krzysztof 707d49e161 docs: Provide instructions on how to resolve issue with 'raggedright' when building openocd from sources 2022-09-20 18:27:17 +08:00
Krzysztof 52595702b4 docs: fix link to VS Code debugging 2022-03-07 19:04:40 +08:00
Krzysztof cc8413a330 docs: Update 'Hardware Reference' section for ESP32-S3 2021-11-02 06:56:12 +01:00
Krzysztof 3247f66783 tools: update ttfw to support ESP32-H2 and ESP32-C6 chips 2021-10-22 16:29:46 +08:00
Krzysztof d22a73155c docs: Provide missing information about OT joiner configuration 
Fix typo
 2021-10-13 17:09:18 +08:00
Krzysztof 1c0b26e7fd docs: Linking to a page that helps navigate to documentation for specific ESP32-x chip 2021-06-02 13:37:07 +02:00
Krzysztof 7b9b489968 docs: Update type of uart_num in UART API Reference examples 2021-04-28 13:11:41 +02:00
Krzysztof 34a16c9d93 docs: Add a link to ESP32-C3 page for developers on espressif.com 2021-04-28 10:42:09 +02:00
Krzysztof 5a8a6c8fff docs: Provide new links to documentation for ESP32-S2 and ESP32-C3 chips 2021-02-18 18:08:58 +08:00
Krzysztof 6df6123ff6 docs: Update full-scale voltages for ESP32-S2 chip 2021-01-19 14:47:17 +08:00
Krzysztof 90c0876b8a docs: Update typos in 'esp_efuse.h' header file to show function descriptions 2021-01-08 15:29:52 +08:00
Krzysztof 37dc6044c3 docs: Add link to layout of ESP-WROVER-KIT board in DXF format 2020-12-17 19:26:05 +08:00
Krzysztof 1c184bd0be docs: ESP-IDF v4.2 fully supports ESP32-S2, remove documentation that describe preview support 2020-12-03 16:21:16 +08:00
Krzysztof 900703b9cf docs: Fix snippet with example cmake build command to create mocks 2020-09-12 01:46:32 +08:00
Krzysztof b686e7d349 doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions 2020-09-11 01:43:21 +08:00
Krzysztof 156fe090be docs: Add profile file name used by zsh shell 2020-09-11 00:33:48 +08:00
Krzysztof db0c6d7921 docs: Add esp_rom_printf to API Reference 2020-09-10 22:55:43 +08:00
Krzysztof 1f565c2313 docs: Provide missing python requirement 2020-08-29 02:50:55 +08:00
Krzysztof f925da9179 docs: correct function description following https://esp32.com/viewtopic.php?f=5&t=16332 2020-06-30 17:56:03 +02:00
Krzysztof ae7ec27125 Resolve broken links reported on https://esp32.com/viewtopic.php?f=5&t=14148#p61449 by chegewara 2020-06-15 21:35:19 +02:00
Krzysztof 1e34a1499b Resolve broken link reported on https://esp32.com/viewtopic.php?f=5&t=14148#p61447 by boarchuz 2020-06-15 21:34:11 +02:00
Krzysztof 9b5acea160 Add missing link to ulp header files and link to example following https://esp32.com/viewtopic.php?f=2&t=15562 2020-05-14 17:31:05 +08:00
Krzysztof 789c42abcd Add another case and recomendation to use Python 3 instead of Python 2 2020-05-13 21:57:51 +02:00
Krzysztof f1c7b0ba6f Resolve documentation issue reported by boarchuz in https://esp32.com/viewtopic.php?f=5&t=14148#p59419 2020-05-07 22:00:27 +02:00
Krzysztof 6070f610cc Implement review comments 2020-01-08 18:41:43 +08:00
Krzysztof 164fd5ad29 More link corrections 2019-08-02 17:58:08 +08:00
Krzysztof d163b9e615 Fix broken links in 'Getting Started' gudes 2019-08-02 17:09:33 +08:00
Krzysztof 363f3e8311 docs: Remove building of zipped HTML docs from build process and consequently from Downloads as many users don't use that. We are still providing PDF documentation for people who prefer viewing docs off-line. Removal of this build step is expected to save almost 10 minutes of build time and resolve issue of build failures because of hitting 40 min build time limit on Read The Docs. 2019-07-08 13:19:56 +08:00
Krzysztof 5aa019fce6 Replace hardcoded links with link roles 2019-07-02 21:01:52 +08:00
Krzysztof 660eb84da7 Correct links 
Closes https://github.com/espressif/esp-idf/issues/3723
 2019-07-02 18:22:33 +08:00
Krzysztof 8d251d7369 Implement review comments 2019-07-02 18:22:33 +08:00
Krzysztof 4e95b1ad21 Provide getting started guide for 'ESP32-Ethernet-Kit' board 2019-06-06 15:45:45 +08:00
Krzysztof 1031f77262 docs: Add mqtt submodule to RTD build configuration. Now any submodule included in documentation build by Doxygen should be included in this file 2019-05-28 20:11:21 +08:00
Krzysztof 27fe2006de Fixed Breathe version to avoid docs build failure on ReadTheDocs server. Provided RTD project configuration file to be able to select python version for specific to esp-idf release. 2019-05-15 20:40:48 +08:00
Krzysztof 754a454402 Introduce separate fonts used by blockdiag, sequdiag, actdiag, nwdiag, rackdiag and packetdiag for Chinese and English version of documentation 2019-05-06 13:19:58 +08:00
Krzysztof 394d89e7da Correct diagram layout to make text descriptions fit into blocks 2019-05-06 13:19:58 +08:00
krzychb 57b2d5ae56 docs: Upgraded sphinx package version to prevent build failures on readthedocs site. Upgraded versions of other packages that are used during documentation build. 2019-03-19 17:04:58 +01:00
krzychb 88b153fcf7 Fixed fancy quotes 2019-03-05 19:21:50 +01:00
krzychb e243ee972d Updated documentation concerning 'PROJECT_VER' and 'PROJECT_NAME'. 
Closes https://github.com/espressif/esp-idf/issues/3115.
 2019-03-05 19:21:50 +01:00
krzychb e1e8c36492 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
krzychb ed0db52f74 docs: This is a quick reference of more than a dozen and-ons and extensions prepared over the last two years to add contents, improve look & feel and cut on maintenance of the ESP-IDF documentation. 2019-02-17 20:32:50 +01:00
krzychb 43c6e77c2f Introduced installation steps to improve navigation through the installation process. Included some updates from GNU make section. 2019-02-17 20:24:17 +01:00
krzychb f675334ebb Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 19:01:34 +01:00
krzychb 7fa8eb91dd Small updates of wording 2019-01-24 19:50:55 +08:00
krzychb 29b1f86f16 Extended information on using pins of ESP-WROVER-KIT that are shared among peripherals. Inspired by https://esp32.com/viewtopic.php?f=12&t=6856. 2018-11-29 16:56:49 +01:00
krzychb 7ef74ee863 Updated 'What you need' picture 2018-11-16 22:18:31 +01:00
Krzysztof bce5d7ba01 Implemented the first round of review comments 2018-09-28 14:04:22 +08:00
Krzysztof cc52029d14 Updated sigma-delta example description to the latest template 2018-09-28 14:04:22 +08:00
krzychb a556240e3e Docs: Renamed download links to clearly state they are to download documentation. Fixed incorrectly linked documentation build badge. 2018-09-17 01:19:45 +00:00
krzychb c8b342cc40 There are now visible links to change between English and Chinese version of documentation. Therefore information on the home page how to switch between languages has been removed. Added 'Download' link to the menu to provide a more visible access to documentation in PDF format for people who prefer to read it offline. 2018-09-12 04:48:50 +02:00
krzychb f6b0b27026 Corrected number of FSM cycles and related description 2018-09-10 07:14:19 +02:00
krzychb 5eee2bf37d Corrected ULP wakeup period setup API to account for time the ULP FSM spends on internal tasks before being able to execute the program. Inspired by https://esp32.com/viewtopic.php?f=2&t=7081. 2018-09-10 07:08:12 +02:00
krzychb 15c10b3cbe Added missing CMakeLists.txt file to satisfy CI checks 2018-09-09 21:32:57 +02:00
krzychb 91c7149f6e Included information about power on and diagnostics LEDs. Closes https://github.com/espressif/esp-idf/issues/2365. 2018-09-06 11:28:23 +02:00
krzychb 1d99531328 Corrected RGB LED pin assignment. Closes https://github.com/espressif/esp-idf/issues/2363. 2018-09-05 22:10:42 +02:00
krzychb 62389b6be6 Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference' 2018-09-05 22:10:42 +02:00
krzychb 1857bca871 Corrected pinout of the Camera / J4 connector 2018-08-21 22:01:28 +02:00
krzychb 4946850e82 Replaced Espressif logo with a new, consistent, modern and neutral typeface design. 2018-08-13 07:22:41 +02:00
krzychb df9c701864 Removed redundant code to configure 'sphinx-rtd-theme' for documentation 2018-08-02 22:10:33 +02:00
krzychb 42cf4429a9 Fixed logo width to display correctly in Chinese version of documentation 2018-07-30 21:16:27 +02:00
krzychb c7ab37143b Logo version 8, vector graphics and a new typeface 2018-07-23 19:18:50 +02:00
krzychb 992ead0671 Logo version 7 - gray logo background, improved contrast, simplified css overrides 2018-07-21 20:06:27 +02:00
krzychb ca15dbd05e Added description of ESP32-PICO-KIT V4.1 board 2018-07-18 20:02:43 +02:00
krzychb 2506a9416e Version 2 of the logo, without a frame an with uniform color 2018-07-18 07:03:00 +02:00
krzychb 2fd5ce3022 Made the logo smaller 2018-07-18 07:03:00 +02:00
krzychb da86681f21 Added Espressif logo to documentation 2018-07-18 07:03:00 +02:00
krzychb 8a7ee46b7f Fixed link to 'TEMPLATE_EXAMPLE_README.md' 2018-07-01 19:33:37 +02:00
krzychb f4ef7689bd The 'Two Point Values' used to calibrate ADC readings, unlike 'eFuse Vref', are not measured and burned into eFuse BLOCK3 for each individual chip during factory calibration. This operation should be done by user, if more accurate calibration is required. 2018-06-29 19:01:11 +02:00
krzychb b101e118f2 Renamed ESP-WROOM-32 to ESP32-WROOM-32/D/U including links to data sheets, reflected upcoming ESP32-SOLO-1 as one of options for ESP32-DevKitC, provided updated schematics and notes on C15. 2018-06-26 18:08:47 +02:00
krzychb 713141e631 Replaced ASCII art drawings with blockdiag drawings 2018-06-06 23:27:05 +02:00
krzychb 42b1ec76b7 Provided links to 'Touch Sensor Application Note' and 'Guide for ESP32-Sense Development Kit' 2018-05-21 19:29:36 +02:00
krzychb 6d85d159d6 Updated pictures of user configurable jumpers to reflect Version 3 of ESP-WROVER-KIT. 
This includes changing the picture of JTAG jumper block by removing the jumper on S_TDI. It has been reported by a number of users that removing this jumper fixes random communication issues observed in OpenOCD.
 2018-05-21 19:29:36 +02:00
krzychb d754b53ae2 Implemented docutils custom role that renders a link to current documentation page on Read The Docs in another language version 
Provided documentation of the role.
 2018-05-21 10:30:07 +08:00
krzychb d19dbea059 Fixed git command 2018-05-15 22:36:34 +02:00
krzychb 684d211af3 Corrected link rendering and additional translations 2018-05-14 19:06:43 +02:00
krzychb 43fb8033ec ReadTheDocs theme has an annoying bug of text not being wrapped inside table cells. Each row is extended to fit the text as a single line. For a table with multiple columns and long sentences the table may get wide, with long scrollbar underneath and is not convenient to read. This MR makes the text wrap inside table cells. There is an open PR to fix this issue - https://github.com/rtfd/sphinx_rtd_theme/pull/432. 2018-04-09 05:47:36 +02:00
krzychb d56a44ac79 Fixed issues with tables 2018-04-09 05:46:57 +02:00
krzychb 621076f329 Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files 2018-03-16 07:54:58 +01:00
krzychb 4a9b44e0c8 Included update made in MR !2012, that has been then lost when resolving merge conflicts of MR !1901 2018-03-14 22:05:36 +01:00
krzychb 36bbfbb4bf Updated instructions to install Eclipse. Closes https://github.com/espressif/esp-idf/issues/1509. 2018-03-14 19:26:59 +01:00
krzychb 852f7f8a36 Updated get started instructions for windows following https://esp32.com/viewtopic.php?f=13&t=4232 2018-03-14 19:26:59 +01:00
krzychb b7f7ac3b28 Implemented review comments to zh_CN version of eclipse setup and PICO-KIT get started guides. Resolved issues after rebasing on master of several commits. 2018-03-13 22:31:54 +01:00
krzychb 6a1b2c6ad0 Included zh_CN version of Eclipse setup and PICO-KIT get started guides 2018-03-13 22:07:31 +01:00
krzychb c63d7a4b5e Adjusted CI configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
krzychb 56d5647d3f Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
krzychb 40bc387bae Restored back original 'zh_CN' version files and updated links between versions 2018-03-13 21:57:08 +01:00
krzychb 097adc3a33 Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00
krzychb c8d8cdbf38 Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version 2018-03-13 21:57:08 +01:00
krzychb e437c7d6ad Exposed important information regrading the flash bus signals 2018-03-12 05:56:35 +01:00
krzychb ef76ae3d29 Extra links in 'Resources' section 2018-03-12 05:56:35 +01:00
krzychb 691b2ad8f3 Added / corrected README files for the SPI master / slave examples under peripherals 2018-03-12 05:56:35 +01:00
krzychb 53e01bfb96 Added missing link to sdkconfig 2018-03-08 10:03:32 +01:00
krzychb b2ecaa64f0 Added a note how to modify ESP-WROVER-KIT V3 hardware to improve flash bus signal's integrity when using 80 MHz flash frequency. Due to length of the signal lines the flash mode QIO + 80M is not stable and may cause random exceptions on the ESP-WROVER-KIT. 2018-03-02 15:26:46 +01:00
krzychb ade6bd4ad8 Added missing references to the current and previous board versions 2018-02-06 18:54:58 +01:00
krzychb c759ff3aab Docs for ESP32 DevKitC V4 2018-01-31 18:31:13 +01:00
krzychb f3ccc5da4f Custom link roles have been extended to provide an option of displaying some text where originally a bare link is rendered 2018-01-17 20:01:36 +01:00
krzychb 03d5af9859 Fixed swapped GPIO6 and GPIO11 in documenation of module pinout, ref. https://esp32.com/viewtopic.php?f=2&t=3880 2018-01-02 22:30:45 +01:00