Mahavir Jain
39744f2e32
Fix regression in docs build failure
2022-02-20 14:15:43 +05:30
pedro.minatel
d049f30ad5
[Docs] Changes according to MR review
2022-02-17 10:50:59 +00:00
daiziyan
a4704d37e6
docs: updated CN translation for new get started
2022-02-17 10:50:59 +00:00
pedro.minatel
e4a766051c
[Docs] Rebase conlicts fixed
...
[Docs] New getting started based on the ide and os selection
Missing file on zh_CN folder added
Added hidden toctree for missing files in CN version
docs: Added steps summary to the macOS procedures
[Docs] Changes on the titles and heading levels
[Docs] Review according to MR 15432
[Docs] Fixed the start a new project secction
2022-02-17 10:50:51 +00:00
Tomas Sebestik
fb12d03dc3
Drop Python 3.6
2022-02-10 07:20:52 +01:00
Ivan Grokhotkov
d2b894862c
newlib: auto-detect sizeof(time_t)
...
To make the transition from 32-bit time_t to 64-bit time_t smoother,
detect the size of this type in CMake and remove the manual option in
Kconfig.
The information about 64-bit time_t support is moved from Kconfig help
string into the "system time" section of the API reference.
2022-01-11 19:01:21 +01:00
daiziyan
a98212015f
docs:update CN transalation for get-started section and sdmmc
2021-12-21 18:43:56 +08:00
radim.karnis
5d55d34481
docs: Update references to esptool docs
2021-11-24 10:28:39 +01:00
Roland Dobai
460f3ad7b6
Merge branch 'feat/drop_msys' into 'master'
...
Tools: Remove MSYS/Mingw support
Closes IDF-3954
See merge request espressif/esp-idf!15862
2021-11-18 10:58:43 +00:00
Lv Xin Yue
2059280445
Doc/add esp32s3 kevkitm 1 user guide cn and en
2021-11-17 11:13:34 +00:00
Roland Dobai
a1d0d1ffbe
Tools: Remove MSYS/Mingw support
...
MSYS/Mingw was deprecated since v4.0 and it is removed in v5.0. Please
follow the getting started guide of the documentation to set up a
Windows Command Line or Power Shell based environment.
2021-11-10 17:25:07 +01:00
Roland Dobai
9c1d4f5b54
Build & config: Remove the "make" build system
...
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
Armando
d41da2792a
doc: add flash and psram configuration doc in programming guide
2021-10-26 11:49:36 +08:00
Jakob Hasse
81e9266204
[examples]: removed hyphens
...
Replaced hyphens with underscores in examples
project definition for all examples which had
hyphens in their project name. dpp-enrollee is
an exceptions because the name matches the
project directory name while the project
directory also contains hyphens.
2021-10-09 13:58:24 +08:00
Juraj Sadel
85f9aa1062
docs: Instructions for Windows download optimization
2021-08-16 12:32:21 +02:00
Wang Ning
baebf74342
docs/add_esp32-s2-devkitc-1_user_guide
2021-07-30 14:00:45 +08:00
Wang Fang
8a6fa2f86c
Merge branch 'docs/add_a_note_and_module_variants_to_esp32-devkitm-1_pico-devkitm-02u' into 'master'
...
Add a note to ESP32-DevKitM-1 User Guide, to enable single core mode
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally
Closes DOC-1620, DOC-1741, and DOC-1774
See merge request espressif/esp-idf!14479
2021-07-30 03:23:08 +00:00
Wang Fang
03669abead
Add a note to ESP32-DevKtiM-1 User Guide, to enable single core mode
...
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally
2021-07-29 18:44:30 +08:00
daiziyan
ce916db7ed
docs: update all documents in get started section and keep line number consistent
2021-07-22 15:54:47 +08:00
Marek Fiala
f6c2198a21
tools: Installing tools for given IDF_TARGET
...
Allow user to select specific ESP_TARGET while setting up ESD_IDF.
Only necessary tools for given target will be downloaded and installed.
Closes https://github.com/espressif/esp-idf/issues/5113
2021-07-16 15:03:19 +02:00
Krzysztof Budzynski
4a87be3ecd
Merge branch 'doc/add_esp32-s3-devkitc-1_user_guide_en' into 'master'
...
docs:add esp32-s3-devkitc-1 user guide
See merge request espressif/esp-idf!14096
2021-07-02 08:14:57 +00:00
Lv Xin Yue
faee145a61
docs:add esp32-s3-devkitc-1 user guide
2021-07-02 15:21:07 +08:00
Krzysztof Budzynski
22d4b24000
Merge branch 'docs/windows_installer_path_limitation' into 'master'
...
docs: add limitation of path lenght for Windows Installer
See merge request espressif/esp-idf!14194
2021-07-02 03:15:24 +00:00
Juraj Michálek
494dd6ea01
docs: add limitation of path lenght for Windows Installer
2021-07-01 12:29:37 +02:00
daiziyan
317ee67c2a
docs: translate ESP32-S3 get started
2021-07-01 15:54:19 +08:00
Marius Vikhammer
638485b222
docs: updated getting started and other misc. guides for S3
2021-06-29 15:44:45 +08:00
Roland Dobai
b22fcbef96
Merge branch 'feature/drop_py2_support' into 'master'
...
Drop support for unsupported Python versions
Closes IDF-1676
See merge request espressif/esp-idf!13622
2021-06-22 09:28:49 +00:00
Roland Dobai
407053592e
Drop support for unsupported Python versions
2021-06-21 21:48:49 +02:00
Juraj Michálek
bd749ad8be
docs: update Windows Tools 2.9 installation
2021-06-21 14:19:40 +02:00
Brian Alberto Ignacio Reyes
b630c45d91
docs: Fix vscode extension setup links
2021-04-23 20:45:24 +08:00
Ivan Grokhotkov
b51a7e0cc7
Merge branch 'feature/win_inst_offline' into 'master'
...
Feature/win inst offline
Closes IDF-2636, IDF-2664, IDFGH-4549, IDFGH-3424, IDFGH-4260, IDFGH-4664, IDFGH-2202, IDFGH-4697, IDF-2742, and IDF-2955
See merge request espressif/esp-idf!12003
2021-04-12 06:54:24 +00:00
Wang Fang
c303333f52
docs: Correct uart default pin names and provid more information about ESP-Prog board
2021-03-29 14:04:13 +08:00
Hao Ning
80da446be7
fix dead links directed to iot solution repo
...
resolve confilcts
modify a board name
rebase master
fix ota example link in readme
2021-03-26 15:19:10 +08:00
Juraj Michalek
70e06a46ba
tools: IDF Windows installer offline mode support
2021-03-24 12:27:46 +01:00
Wang Ning
424fe73a23
Add ESP32-C3-DevKitC-02 User Guide
2021-03-17 06:40:33 +00:00
Dai Zi Yan
97ec83fa78
Provide CN translation for get-started section in MR12242
2021-02-18 15:16:58 +01:00
Juraj Michálek
419673fa96
docs: add links to Windows installer 2.5 Offline and Online versions
2021-02-18 15:16:58 +01:00
Roland Dobai
47f67f8b81
tools: Prefer python3 during install and export
...
Install and export script should work on systems without "python"
executable.
Closes https://github.com/espressif/esp-idf/pull/6471
Closes https://github.com/espressif/esp-idf/issues/6532
Related to https://github.com/espressif/esp-idf/issues/6421 and
https://github.com/espressif/arduino-esp32/issues/4717
2021-02-13 11:34:40 +01:00
Wang Ning
aa2b3e1b01
Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS
2021-02-05 12:08:21 +08:00
Marius Vikhammer
548fd02d10
docs: initial update of programming guide for C3
...
Updates "front page" content, get-started, and api-guides with C3 content
Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
Krzysztof Budzynski
9a5bd86d54
Merge branch 'docs/update_docs_based_on_the_second_batch_of_customer_feedbacks' into 'master'
...
docs: update documents based on doc-855, doc-885, doc-889, doc-897
See merge request espressif/esp-idf!12124
2021-01-26 16:21:26 +08:00
Wang Fang
4c31cf9804
docs: Update FreeRTOS version, add tips to set up instructions for Windows
2021-01-26 03:46:25 +00:00
Wang Fang
7df1cad1d6
docs: This MR does the following updates:
...
1. Provided more information regarding I2S_COMM_FORMAT_STAND_PCM_SHORT and I2S_COMM_FORMAT_STAND_PCM_LONG
2. Added --output flag for partition table read instructions
3. Reordered the header files for esp-ble-mesh
4. Reordered the setup instructions for Ubuntu and CentOS
2021-01-25 11:10:08 +00:00
Ivan Grokhotkov
76acc8ddde
Merge branch 'feature/win_inst_embedded_python' into 'master'
...
tools: support for embedded Python
Closes IDF-322
See merge request espressif/esp-idf!11682
2021-01-18 16:54:47 +08:00
Juraj Michálek
1427b3a6d8
tools: support for embedded python
2021-01-18 08:10:56 +01:00
Angus Gratton
e2910d2ff5
doc: Add libusb package dependencies for Arch, CentOS
...
- Arch uses 'libusb' package, provides libusb-1.0.so
- CentOS has moved to 'libusbx', which is libusb-1 API compatible
Related to https://github.com/espressif/esp-idf/issues/4095
2021-01-13 05:15:27 +00:00
mjdr
f12544a04e
doc: Add libusb dependency for Ubuntu
...
Patch from https://github.com/espressif/esp-idf/pull/4669
Closes https://github.com/espressif/esp-idf/issues/4095
Related to https://github.com/espressif/esp-idf/issues/5181
2021-01-13 05:15:27 +00:00
Dai Zi Yan
703aef654b
provide user guide for ESP32-DevKitM-1
2021-01-05 12:32:08 +08:00
Wang Fang
cf505d0ead
docs: update the documents based on customer feedbacks
2020-12-31 05:40:43 +00:00
Wang Fang
8dbd5a48a8
provide user guide for the development board ESP32-PICO-DevKitM-2
2020-12-14 18:26:44 +08:00
Ivan Grokhotkov
46cfc436ad
Merge branch 'feature/idf_tools_github_mirror' into 'master'
...
Add GitHub mirror option for IDF tools installs
Closes IDF-2028
See merge request espressif/esp-idf!10616
2020-12-14 15:58:51 +08:00
Wang Fang
bdeb3a2fb6
upload user guide for development board: ESP32-PICO-KIT-1
2020-12-09 08:27:25 +00:00
Angus Gratton
291af6e766
tools: Use GitHub download URLs for all files that can be downloaded from GitHub
2020-12-03 17:50:42 +11:00
Angus Gratton
4a738721f1
idf_tools: Add option to replace all GitHub tools download URLs with dl.espressif.com
...
Via new IDF_GITHUB_ASSETS environment variable.
2020-12-03 17:49:37 +11:00
Krzysztof Budzynski
5f5ae17bc8
Merge branch 'feature/python2-deprecation-warn' into 'master'
...
Tools: Add Python 2 deprecation warning
Closes IDF-1677
See merge request espressif/esp-idf!11115
2020-12-02 19:26:46 +08:00
daiziyan
33c414087b
add CN translation for adding python2 deprecation warning(MR 11115)
2020-12-02 11:11:57 +01:00
martin.gano
f4ea2dcb74
Tools: add Python 2 deprecation warning
2020-12-02 11:08:48 +01:00
daiziyan
62f7a1b545
fix merge conflicts
2020-12-02 16:50:07 +08:00
Juraj Michálek
5a2d84324d
docs: add ESP-IDF Windows Installation limitations.
2020-12-01 07:33:47 +01:00
Dai Zi Yan
c7bebb0413
Doc/update CN translation for files on setting up toolchain from scratch in get started
2020-11-30 17:58:27 +08:00
Dai Zi Yan
c2818e775c
Updated CN translation for index.rst and establish-serial-connection.rst and add CN translation for VScode-setup.rst in get-started folder to get EN and CN translation in sync
2020-11-25 14:45:26 +08:00
Ivan Grokhotkov
e9e6d970f3
Merge branch 'feature/add-shell-autocompletion' into 'master'
...
idf.py: Enable autocompletion for command idf.py
Closes IDF-1540
See merge request espressif/esp-idf!10742
2020-11-06 20:14:38 +08:00
Wang Ning
f87cbdee28
Add ESP32-S2-DevKitM-1 User Guide
...
Update 1 based on comments
Fix typo
Add annotation to UFL connector
Add UFL connector to description table
2020-11-06 00:50:33 +00:00
martin.gano
346b002d9a
enable autocompletion for command idf.py
2020-11-03 23:27:58 +01:00
Krzysztof Budzynski
077bbb8647
docs: Clarify how to establish a serial connection to the device using macOS
2020-10-15 15:26:46 +08:00
Wang Fang
00a99cfb9d
docs: fix formatting issues in api-guides
2020-09-24 15:30:28 +08:00
Krzysztof Budzynski
4547c0876a
Merge branch 'feature/guide_change_for_catalina' into 'master'
...
docs: Add profile file name used by zsh shell
Closes DOC-325
See merge request espressif/esp-idf!10320
2020-09-11 16:42:30 +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 Budzynski
2d4e0a4496
docs: Add explanation of hello_world folder contents
2020-09-10 22:29:24 +08:00
Roland Dobai
23eadafd38
Fix the setup instructions in the main README
2020-09-07 16:06:05 +02:00
Soumesh Banerjee
22301653c6
VSCode Extension Setup Guide
2020-09-02 00:07:31 +08:00
Wang Fang
a5e5794059
docs: add a command to create an esp directory before cloning esp-idf
2020-08-31 09:12:21 +00:00
Krzysztof Budzynski
d16a17b01a
docs: Add missing target setting in step 7 of Getting Started documentation
2020-08-28 20:23:17 +08:00
Wang Fang
12c91ee362
Update the description to reflect Python3 as the default interpreter DOC-258
2020-08-11 20:43:31 +08:00
yiying
0cca898e19
docs: change redirection link in get-started
...
This link is supposed to go to Step 3, but it goes to Step 2.
2020-07-22 16:19:11 +08:00
Marius Vikhammer
4d6030e03f
doc: update chip features in getting started
...
Fixed number of cores for ESP32 and ESP32S2 being wrong.
Updated S2 to reflect that we have to ULP coprocessors
Closes IDFGH-3616
Closes https://github.com/espressif/esp-idf/issues/5556
2020-07-10 09:50:55 +08:00
Krzysztof Budzynski
7099c2b444
Merge branch 'doc/generate_idf_project_tags' into 'master'
...
doc: add generation of tags from sdkconfig and x_caps.h headers
Closes IDF-1484
See merge request espressif/esp-idf!8577
2020-05-20 23:46:47 +08:00
Angus Gratton
ee8796b169
Merge branch 'bugfix/doc_version_links' into 'master'
...
doc: Fix broken Release page links when building a stable version
See merge request espressif/esp-idf!8819
2020-05-20 13:16:46 +08:00
Angus Gratton
fdfb029711
doc: Fix broken Release page links when building a stable version
2020-05-20 10:50:44 +10:00
Krzysztof
789c42abcd
Add another case and recomendation to use Python 3 instead of Python 2
2020-05-13 21:57:51 +02:00
Kirill Chalov
2e5f983b5a
Add user guides for ESP32-S2-Kaluga-1-Kit
2020-05-13 07:12:42 +00:00
Marius Vikhammer
fbb54184ef
doc: add generation of tags from sdkconfig and x_caps.h headers
...
Also updates the way we handle exclude_patterns to use the new tags
Closes IDF-1484
2020-05-13 07:09:01 +00:00
Wang Ning
8b8d03f7bd
Update Build and Flash with Eclipse IDE to make terminology consistent
2020-05-11 16:51:30 +08:00
Ivan Grokhotkov
a9c7db135d
Merge branch 'bugfix/get_started_export_profile' into 'master'
...
docs: remove suggestion about running export.sh from .profile script
Closes IDFGH-1640
See merge request espressif/esp-idf!8320
2020-05-04 15:46:24 +08:00
Roland Dobai
ab9f714248
Add build system support for programming ESP32-S2 using DFU utils
2020-04-30 07:59:18 +02:00
Ivan Grokhotkov
01b3ffa8e3
docs: remove suggestion about running export.sh from .profile script
...
This was quite obviously a bad suggestion, and it seems that some
users have actually read the docs attentively enough to have followed
it. Replace be recommendation to create an alias.
Closes https://github.com/espressif/esp-idf/issues/3889
2020-04-29 23:43:14 +02:00
Fu Hanxi
5b2fa1a5ad
build_app: make multi target support readable
2020-04-09 16:40:57 +08:00
Wang Ning
a0c37ae1bd
Add ESP32-S2-Saola-1 User Guide
2020-03-26 18:40:05 +08:00
Angus Gratton
52d888a68b
docs: Fix broken URLs & permanent redirects
2020-03-23 18:11:23 +11:00
Wang Ning
b85358e593
Updated index
...
components/esp_wifi/lib_esp32/
2020-03-11 06:43:31 +08:00
Krzysztof Budzynski
2178e3fba4
docs: Update getting started guide for ESP32-S2 target
2020-03-05 05:05:23 +08:00
Kirill Chalov
1ead668d77
Issues with entering Download mode automatically
...
Add description to Getting started guides of possible issues preventing Development boards from entering Firmware Download mode automatically while trying to flash the boards
Closes https://jira.espressif.com:8443/browse/DOC-11
2020-03-04 04:58:29 +08:00
Roland Dobai
5c0cd9417d
Docs: Encourage to used Python 3
2020-02-24 12:55:55 +01:00
Ivan Grokhotkov
700161921c
docs: update version of IDF tools installer for windows to v2.3
2020-02-11 19:05:17 +01:00
Marius Vikhammer
1a90470f02
doc: Split HW-Reference into seperate files/folders for different chips
2020-02-07 16:37:44 +11:00
Marius Vikhammer
d56ea52ea1
doc: EN doc update and fixed warnings
2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69
doc: Update English pages with generic target name
2020-02-07 16:37:43 +11:00
Angus Gratton
b0748b4364
docs: Mark some more docs sections as ESP32 only
2020-02-07 16:37:43 +11:00
Angus Gratton
9399f04da0
docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs
2020-02-07 16:37:43 +11:00