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
Angus Gratton
cff2ef695a
Merge branch 'master' into feature/cmake
2018-09-06 20:23:04 +08: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
Ivan Grokhotkov
312424b5ac
docs: update command to get compiler specs in a few more places
2018-09-05 11:05:52 +08:00
Angus Gratton
a9c4ed7139
Merge branch 'master' into feature/cmake
2018-08-30 18:51:01 +08:00
morris
988dfc6546
doc: additional translation in get_stated
2018-08-27 10:44:28 +08:00
Roland Dobai
52d11dcfb0
docs: make the use of pip install clear
2018-08-23 11:41:56 +02:00
morris
1a79900970
translated some parts in get-started section to zh_CN
...
1. "install required python packages" in docs/zh_CN/get-started/index.rst
2. docs/zh_CN/get-started/linux-setup-scratch.rst
3. docs/zh_CN/get-started/linux-setup.rst
4. docs/zh_CN/get-started/macos-setup-scratch.rst
5. docs/zh_CN/get-started/macos-setup.rst
2018-08-23 08:28:57 +02:00
Roland Dobai
62cad3a7d7
Add python-future by using python requirements file
2018-08-23 08:28:57 +02:00
Angus Gratton
ff2404a272
Merge branch 'master' into feature/cmake
2018-08-16 17:14:17 +10:00
Angus Gratton
191557db02
docs: Copy CMake docs to a separate set of directories
...
Required first step before merging back to mainline.
2018-08-13 15:37:03 +10:00
Michael (XIAO Xufeng)
522f9c4b4a
docs: translate the version include script to Chinese
2018-08-09 11:08:03 +10:00
Carney Wu
7ccc28de6c
alias 需要添加到 .bashrc 文件中
...
Merges https://github.com/espressif/esp-idf/pull/2097
2018-07-09 14:36:47 +08:00
Jin Fang Cheng Cheng
9e3c3f267e
Update eclipse-setup.rst
2018-06-28 17:58:19 +08:00
Jin Fang Cheng Cheng
3d6d252b3e
Update eclipse-setup-windows.rst
2018-06-28 17:57:55 +08:00
Jin Fang Cheng Cheng
d9653e75e9
Update eclipse-setup.rst
2018-06-28 15:16:20 +08:00
Jin Fang Cheng Cheng
084a6b54e2
Update eclipse-setup-windows.rst
2018-06-28 15:10:36 +08:00
Jin Fang Cheng Cheng
a0928b4ce2
Update eclipse-setup-windows.rst
2018-06-28 15:00:40 +08:00
Jin Fang Cheng Cheng
6a1250cf19
Update eclipse-setup.rst
2018-06-26 13:15:13 +08:00
Jin Fang Cheng Cheng
fe7647936a
Update eclipse-setup-windows.rst
2018-06-26 13:13:08 +08:00
Jin Fang Cheng Cheng
d57649aed1
Update eclipse-setup-windows.rst according to https://gitlab.espressif.cn:6688/idf/esp-idf/merge_requests/2617 .
2018-06-26 12:55:34 +08:00
Jin Fang Cheng Cheng
0a033b5e05
Update eclipse-setup.rst according to https://gitlab.espressif.cn:6688/idf/esp-idf/merge_requests/2617
2018-06-26 12:54:15 +08:00
Angus Gratton
59ab2136e8
Merge branch 'doc/kconfig_item' into 'master'
...
doc: fix the level inconsistent issue in Kconfig document
See merge request idf/esp-idf!2460
2018-06-14 12:51:50 +08:00
Jin Fang Cheng Cheng
f9a3368f28
Update eclipse-setup.rst
2018-06-08 11:00:29 +08:00
michael
3ba8461928
doc: fix the level inconsistent issue in Kconfig document
2018-06-05 10:36:18 +00:00
wushifu32
736e10749f
correct eclipse build command
...
Merges https://github.com/espressif/esp-idf/pull/2024
2018-06-04 17:19:28 +10:00
Angus Gratton
6b9784cc45
Merge branch 'master' into feature/cmake_update
2018-05-31 14:46:23 +10:00
Mahavir Jain
8ad8a44709
docs: fix (in remaining places) link for FTDI VCP drivers
...
Signed-off-by: Mahavir Jain <mahavir@espressif.com>
2018-05-22 08:21:37 +00:00
michael
d4deb9319a
doc(global): build cross-language links for translated documents
2018-05-21 10:30:13 +08:00
Angus Gratton
c7f19e76d7
docs: Move main docs to cover CMake
...
Add "GNU Make build system" doc with "cheat sheet" for moving to new system
2018-05-07 18:45:49 +08:00
Ivan Grokhotkov
c876ab390b
Merge branch 'bugfix/cn_windows_setup_doc_fixes' into 'master'
...
Update windows-setup.rst
See merge request idf/esp-idf!2232
2018-04-12 16:37:41 +08:00
Angus Gratton
eb731030a4
doc: Add gcc to list of ESP-IDF prerequisite packages
...
Closes https://github.com/espressif/esp-idf/issues/1842#issuecomment-380274150
2018-04-11 10:19:24 +10:00
Lv Xin Yue
4810f5d02e
Update windows-setup.rst
2018-04-08 17:05:02 +08:00
Lin Meiling
707785c306
Update idf-monitor.rst
2018-03-29 14:16:22 +08:00
Lin Meiling
8e7fce51a2
docs: add get-started doc Chinese translation
2018-03-23 14:42:14 +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
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