Commit Graph

63 Commits

Author SHA1 Message Date
Brian Alberto Ignacio Reyes
f50a8cc7b5 docs: Fix vscode extension setup links (backport v4.3) 2021-06-16 10:56:40 +08:00
Wang Ning
613201c24d Add ESP32-C3-DevKitC-02 User Guide and fix some typos 2021-04-22 15:34:45 +08: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
Dai Zi Yan
703aef654b provide user guide for ESP32-DevKitM-1 2021-01-05 12:32:08 +08: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
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
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
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
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
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
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
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
9399f04da0 docs: Add 'toctree filter' directive & filter out ESP32-only pages from S2 docs 2020-02-07 16:37:43 +11:00
Angus Gratton
37d5e2fba6 docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of 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
bd2fc9f832 Make menuconfig colors configurable
Closes https://github.com/espressif/esp-idf/issues/4387
2019-11-26 10:40:34 +01:00
Andrei Gramakov
79dd142ab8 tools: add install.ps1, export.ps1
Closes IDF-855
2019-08-27 13:45:50 +08: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
Angus Gratton
62ed221daf docs: Functional renaming commit for CMake-as-default
Rename all the files which will be edited substantially in the next commit, without changing their
contents

Docs will not build for this ocmmit.

This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which
is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-07-08 17:31:27 +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
Krzysztof
4e95b1ad21 Provide getting started guide for 'ESP32-Ethernet-Kit' board 2019-06-06 15:45:45 +08:00
liying
957301f293 add translation for devkitc guides and index files 2019-03-27 17:41:36 +00: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
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
Anton Maklakov
4a126e18ed docs: Correct Linux port names for more relevance 2018-10-21 15:11:45 +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