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
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
Dai Zi Yan
5aaa0c9ca3
Provide CN translation for part of documents in MR11884
2021-02-02 09:19:58 +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
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
daiziyan
0f3595b1e8
add CN translation for index.rst in get started section for MR10616
2020-12-07 16:36: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
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
Krzysztof Budzynski
b6645c7379
Merge branch 'doc/update_Chinese_translation_for_four_files_in_get-started_folder' into 'master'
...
updated Chinese translation for four files in get-started folder
See merge request espressif/esp-idf!10927
2020-11-30 18:06:10 +08:00
Dai Zi Yan
8b63b35005
updated Chinese translation for eclipse-setup linux-setup macos-setup and windows-setup to get EN and CN in sync
2020-11-30 18:06:05 +08: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
Wang Fang
00a99cfb9d
docs: fix formatting issues in api-guides
2020-09-24 15:30:28 +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 Budzynski
2d4e0a4496
docs: Add explanation of hello_world folder contents
2020-09-10 22:29:24 +08: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
Angus Gratton
fdfb029711
doc: Fix broken Release page links when building a stable version
2020-05-20 10:50:44 +10:00
Kirill Chalov
2e5f983b5a
Add user guides for ESP32-S2-Kaluga-1-Kit
2020-05-13 07:12:42 +00:00
Wang Ning
8b8d03f7bd
Update Build and Flash with Eclipse IDE to make terminology consistent
2020-05-11 16:51:30 +08:00
Roland Dobai
ab9f714248
Add build system support for programming ESP32-S2 using DFU utils
2020-04-30 07:59:18 +02:00
liying
572ef008a9
Provide translation for the updates in 7637 and 8095, and correct a format issue in documenting-code
2020-03-29 16:50:40 +00: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
Ivan Grokhotkov
b497819667
docs: update esp32s2 summary page
...
- Refer to the toolchain links on IDF Tools page
- Update the wording around v4.1/v4.2 releases
- Remove the section about 3 different versions (of S2-beta)
- Add link to the list of features maintained externally
2020-03-16 14:40:37 +11:00
Wang Ning
b85358e593
Updated index
...
components/esp_wifi/lib_esp32/
2020-03-11 06:43:31 +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
cfeb9e68cb
doc: Changed Chinese doc to use dynamic chip name
2020-02-07 16:37:43 +11:00
Angus Gratton
66462ca26f
docs: Apply the same basic ESP32/ESP32-S2 warning filters to Chinese docs
2020-02-07 16:37:43 +11:00
Angus Gratton
e6211c7864
docs: add new top-level docs builder that builds docs for a single chip
2020-02-07 16:37:43 +11:00
Roland Dobai
bbbc12478a
Docs: Update Debian & Ubuntu install prerequisites
...
Latest versions of apt-get don't install as much packages by default
as older ones. This fix adds some missing packages discovered for an OS
derived from the latest stable Debian. These packages exist for older
Debian derivatives as well (tested with Ubuntu 16.04 LTS).
Closes https://github.com/espressif/esp-idf/issues/4480
2019-12-16 11:41:28 +01:00
Ivan Grokhotkov
f91c5c6f23
docs: update Windows tools installer link
2019-12-13 15:03:09 +01:00
Roland Dobai
01887f71e7
Update kconfiglib to upstream version and replace mconf-idf
...
Special thanks to @ulfalizer for the helpful suggestions regarding
kconfiglib.
"rsource" option is available for relative path includes
Closes https://github.com/espressif/esp-idf/issues/4064
2019-10-29 10:40:04 +01:00
Natasha
b0f2bb2adc
Add translation for getting started guide - batch 1
2019-10-10 16:52:07 +08:00
suda-morris
7237e6fab7
docs: jtag-debugging: update translation
2019-08-20 14:49:48 +02:00
Kirill Chalov
639687f92b
Replace gif images on EN and zh_CN index pages with identical png images for successful building of PDFs on ReadTheDocs.
2019-07-23 17:45:41 +08:00
Angus Gratton
80e9faaf1c
docs: Move Legacy Get Started guide to the Related Documents section
2019-07-09 20:35:34 +10:00
Angus Gratton
222146845c
docs: Make CMake build system default, mark GNU Make as legacy option
...
All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-07-09 14:32:26 +10:00
Wang Fang
b24341a664
Merge make-related documents:
...
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder;
2. Deleted get-started files, 7 documents in total, in get-started folder;
3. Updated links in get-started-cmake/index.rst and in get-started/index.rst;
4. Modified descriptions for build system in these files.
2019-07-04 13:16:18 +08:00
Ivan Grokhotkov
0e6ffd08b7
docs: update msys environment links for esp32-2019r1 toolchain
2019-06-11 22:22:14 +08:00
Krzysztof
4e95b1ad21
Provide getting started guide for 'ESP32-Ethernet-Kit' board
2019-06-06 15:45:45 +08:00
Natasha
440c42693d
Add translation for ESP32-WROVER-KIT Getting Started Guides
2019-05-27 07:53:20 +08:00
Natasha
975a9c49f0
Add translation for ESP32-PICO-KIT Getting Started Guides
2019-05-13 11:19:52 +08:00
liying
1cee7d4746
Fix a very important typo that cannot wait
2019-04-03 18:34:34 +08:00
Alexey Gerenkov
8c6a924cdf
sys_view: Adds processing scripts for heap & log traces
2019-04-01 19:31:45 +03:00
liying
957301f293
add translation for devkitc guides and index files
2019-03-27 17:41:36 +00:00
Kirill Chalov
a1c39e4a53
Doc/review get st wrover kit
2019-03-26 16:12:42 +08:00
Kirill Chalov
49cca9288f
Update IDF getting started sections for make and cmake as well as IDF monitor…
2019-03-14 00:10:26 +08:00
Roland Dobai
f0194f2a5e
docs: Update package dependencies
...
Closes https://github.com/espressif/esp-idf/issues/2384
2019-03-07 14:46:59 +01:00
Angus Gratton
aa4a5668b0
Merge branch 'bugfix/add_missing_links_to_translation' into 'master'
...
Included missing links between English and Chinese documentation, where…
See merge request idf/esp-idf!4176
2019-01-30 11:32:15 +08:00
Anton Maklakov
1332d3ba9c
docs: Correct priorities in the PATH string
...
Fixes https://github.com/espressif/esp-idf/pull/2944
2019-01-28 11:28:55 +08: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
suda-morris
b47fda98f3
update translation of establish-serial-connection
2019-01-24 19:50:55 +08:00
Angus Gratton
88150cb9bb
docs: Make Getting Started (CMake) guides version-aware
...
Also clean up some changes in Chinese CMake guide which were not propagated from the English guide.
2018-12-21 19:13:20 +11:00
Krzysztof Budzynski
340e7f3b2f
Provided translation of 'Hardware Reference' into Chinese
2018-12-03 07:02:33 +08:00
Renz Christian Bagaporo
1600c3144c
docs: add pyparsing install to setup guide
2018-11-22 22:09:43 +08:00
Prasad Alatkar
b1189e9645
Docs: Change makes Eclipse setup inline with Mac OS and Linux.
2018-11-19 12:15:53 +08:00
Natasha
be0123e10e
Feature/update board guides for headers
2018-11-12 09:15:29 +08:00
morris
0a2049582e
bugfix: minor_doc_fixes into Chinese
2018-10-26 12:42:38 +08:00
Krzysztof Budzynski
46c2112400
Added CN version of 'Getting Started' guides for 'ESP32-DevKitC' and 'ESP-WROVER-KIT'
2018-10-22 09:10:58 +08:00
Angus Gratton
7313e39fde
Merge branch 'feature_add_path_tools_pr2410' into 'master'
...
add_path.sh: cmake: add tools folder to the path
See merge request idf/esp-idf!3344
2018-10-05 12:34:10 +08:00
Angus Gratton
319fa2264f
windows: Update MSYS2 environment, add Python requirements to setup script
2018-10-01 16:16:49 +10:00
Anton Maklakov
7c8d5d2782
docs, scripts: Correct the priority of the PATH setting
2018-09-27 14:55:37 +08:00
Ivan Grokhotkov
e1ac237169
Merge branch 'doc/fix_config_links' into 'master'
...
doc: Fix config links, add navigation lists to config items page
See merge request idf/esp-idf!3310
2018-09-25 18:23:24 +08:00
Ivan Grokhotkov
91fa1764e5
docs: generate toolchain download links
2018-09-20 18:53:14 +08:00
Angus Gratton
8721173109
doc: Replace :envvar: config links with :ref:
2018-09-19 17:27:48 +10:00
Ivan Grokhotkov
789855e71b
esp32: abort when running on single core chip in dual core mode
...
Ref. https://esp32.com/viewtopic.php?f=2&t=7307
2018-09-19 15:05:26 +08:00
Roland Dobai
c3d99dd2e4
Encourage to install python packages without administrative rights
...
Using 'sudo pip install' can cause a lot of problems because usually
there are a couple of Python interpreters installed. This fix encourages
developers to use `pip install --user` instead which is safer.
2018-09-11 08:54:37 +02:00
Roland Dobai
5eb452f72e
Add required Python packages
...
On some systems pip and setuptools are no longer installed as
dependencies of the python packages. This commit adds the requirement
for these packages.
2018-09-11 08:54:37 +02:00
Angus Gratton
229fe8e2e4
Merge branch 'feature/esp-wrover-kit-v4_1' into 'master'
...
Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference'. Closes https://github.com/espressif/esp-idf/issues/2363 . Closes https://github.com/espressif/esp-idf/issues/2365 .
See merge request idf/esp-idf!3161
2018-09-10 14:48:41 +08:00
Angus Gratton
e7243a2cdd
Merge branch 'doc/eclipse_parallel_build' into 'master'
...
doc: Add parallel builds to the Eclipse setup guide
See merge request idf/esp-idf!3209
2018-09-07 16:03:53 +08:00
morris
1e9ce6a2e1
doc: translate parallel build in Eclipse
2018-09-07 14:39:40 +08:00