Marius Vikhammer
531cab5fc4
docs: fix doxygen compile warnings for doxygen 1.9.1
...
Newer versions of doxygen will give warnings for comments in
INPUT lists
Delete all comment lines to fix these warnings, our folder structure
stil gives an OK overview of what we are including
2021-04-12 08:44:04 +08:00
Roland Dobai
b086a41569
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-14 19:47:14 +01:00
Marius Vikhammer
8e7e0973db
docs: self host docs
...
Move doc hosting from readthedocs to espressif servers
Update CI, Sphinx configs and add IDF Sphinx theme
2021-02-08 11:54:11 +08:00
daiziyan
4c65e031ea
add CN translation for adding python2 deprecation warning(MR 11115)
2020-12-09 23:50:19 +01:00
Dai Zi Yan
14de2ba81a
update CN translation for index.rst in get-started folder (v4.0)
2020-12-08 10:44:40 +08:00
Krzysztof
312504a52f
doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions
2020-10-09 02:52:09 +00:00
Angus Gratton
3350a108c3
build system: Also get IDF version from annotated tags only
...
Builds on previous commit.
Note: Getting the project version still pases --tags so still works with plain
tags, to keep compatibility for existing projects
2020-10-07 13:55:53 +11:00
yiying
61bc60213e
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 17:17:38 +08:00
Ivan Grokhotkov
1e95aba03a
Merge branch 'feature/msys2_env_update_v4.0' into 'release/v4.0'
...
windows: Update MSYS2 pre-compiled legacy build environment (v4.0)
See merge request espressif/esp-idf!9144
2020-07-06 15:16:39 +08:00
morris
b53c59b7a4
tools: fix python lint
2020-06-24 13:22:21 +08:00
Angus Gratton
a972d3018c
windows: Update MSYS2 pre-compiled legacy build environment
...
* Bundled with esp2020r2 toolchain
* Built with Python 3 & latest MSYS2 packages
2020-06-12 10:24:29 +10:00
Anton Maklakov
7d6bcf5f5e
docs: Fixup format of a command line to build unit tests
2020-06-03 12:17:36 +07:00
Angus Gratton
90f6c9652e
Merge branch 'doc/openocd_security_features_v4.0' into 'release/v4.0'
...
doc: Add caveats about using JTAG debugging with hardware security features (v4.0)
See merge request espressif/esp-idf!8464
2020-05-27 07:49:44 +08:00
lly
bcc1eb916b
ble_mesh: Rename the folders ble_mesh_fast_prov_* to fast_prov_*
2020-05-22 14:28:38 +08:00
Angus Gratton
6153026f22
doc: Fix broken Release page links when building a stable version
2020-05-20 11:32:53 +10:00
lly
9370264cac
doc: Fix some ble mesh description
2020-04-27 15:25:46 +08:00
Angus Gratton
07c1d9d9c7
doc: Add warnings about using JTAG debugging with hardware security features
...
This is related to the following issues but is not a fix, just documentation of a workaround until we can
improve the support:
https://github.com/espressif/esp-idf/issues/4878
https://github.com/espressif/esp-idf/issues/4734
2020-04-27 16:41:16 +10:00
liying
4131b51c16
Backport changes made in 6147 to release/4.0
2020-04-20 21:47:26 +08:00
Renz Christian Bagaporo
0f036b8749
ulp: use quotes when specifying files for embedding ulp binaries
2020-03-22 21:07:58 +08:00
Krzysztof
c924da6f0a
Include feedback link in footer
2020-02-29 00:32:55 +08:00
Roland Dobai
2a4173e9a6
Docs: Encourage to used Python 3
2020-02-26 09:01:42 +01:00
Roland Dobai
46cb254f21
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-17 13:38:22 +01:00
morris
0508ad525a
ethernet: add pm lock
2019-12-03 17:37:45 +08:00
Krzysztof Budzynski
f9fa039826
Provide BLE Mesh documentation
2019-10-31 17:08:26 +08:00
Jiang Jiang Jian
815d7674ef
Merge branch 'bugfix/openocd_instructions_v4.0' into 'release/v4.0'
...
docs: jtag-debugging: update for IDF Tools installation method (backport v4.0)
See merge request espressif/esp-idf!6066
2019-09-25 16:15:07 +08:00
Angus Gratton
10649ae23b
app_update: Remove deprecated "make erase_ota" target
...
Deprecated in v3.2
2019-09-19 18:45:36 +10:00
suda-morris
6df148aa54
docs: jtag-debugging: update translation
2019-09-10 17:12:48 +02:00
Ivan Grokhotkov
3fc9b022b6
docs: jtag-debugging: update for IDF Tools installation method
...
- rely on OPENOCD_SCRIPTS variable in all cases, remove -s flags
- replace installation section with a reference to the Getting Started
guides
- add Windows-specific commands in a few cases
2019-09-10 17:12:48 +02:00
suda-morris
28ee1c0da2
doc: update translation of ulp install instuctions
2019-09-10 17:10:17 +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
Wang Ning
d767e0edc7
Add Chinese translation to api-reference/network/esp_smartconfig.rst
2019-07-19 19:04:44 +08:00
Ivan Grokhotkov
83277fe0f2
docs: add tools section and IDF docker image page
2019-07-18 06:18:04 +00: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
05ac8cfb6d
docs: Update description for Eclipse+Cmake support not ready yet
2019-07-09 14:32:26 +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
47bbb107a8
build system: Use CMake-based build system as default when describing commands
2019-07-08 17:31:27 +10:00
suda-morris
471f4b2f0e
zh_CN translation of fatal_error
2019-07-04 14:01:53 +08: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
Anurag Kar
b75f8b1b20
ESP Local Control Feature Added
...
List of changes:
* New component esp_local_ctrl added
* Example added under examples/protocols/esp_local_ctrl
* Documentation added under protocols/esp_local_ctrl
* Demo client side app esp_local_ctrl.py added under examples/protocols/esp_local_ctrl/scripts
* protocomm_ble : protocomm_ble_config_t given struct name for allowing forward declaration
* esp_prov/transport_softap renamed to transport_http
* transport_http module supports verification of server certificate
* transport_http module performs name resolution before connection
2019-07-03 21:31:04 +05:30
Ivan Grokhotkov
6f5c7a21ac
docs: update CMake getting started guide to use install.bat and export.bat
2019-07-01 18:08:02 +02:00
Hrishikesh Dhayagude
cba69dd088
Bluetooth examples restructuring
...
The existing Bluetooth examples are split as:
1. examples/bluetooth/bluedroid - Bluedroid Host (BT + BLE) examples
a. examples/bluetooth/bluedroid/classic_bt - Classic BT examples
b. examples/bluetooth/bluedroid/ble - BLE examples
c. examples/bluetooth/bluedroid/coex - Classic BT and BLE coex examples
d. examples/bluetooth/bluedroid/hci - VHCI and HCI UART examples
i. Rename ble_adv to controller_vhci_ble_adv and move it in hci folder
2. examples/bluetooth/nimble - NimBLE BLE Host + NimBLE Mesh examples
3. examples/bluetooth/esp_ble_mesh - ESP BLE Mesh examples
4. Update documentation references
2019-07-01 19:21:57 +08:00
Roland Dobai
f56b7d4a1d
tools: Accept CTRL-T + A for app-flash in idf_monitor
...
"CTRL-A" cannot be captured in Windows command line, so "A" can be used
instead.
2019-06-27 12:21:09 +02:00
Wang Fang
32954e5f90
Add Chinese translation to api-reference/system/power-management.rst
...
1. Add translation to docs/zh_CN/api-reference/system/power_management.rst
2. Add a link to docs/en/api-reference/system/power_management.rst
2019-06-26 20:42:56 +08:00
Wang Fang
9fbb27b194
Add Chinese translation for exteral-ram.rst in api-guides:
...
- The draft should be first reviewed by Technical Reviewers;
- Then by Language Reviewer.
2019-06-26 19:59:21 +08:00
Jiang Jiang Jian
291e25baa6
Merge branch 'bugfix/btdm_add_readme_for_BLE_demos' into 'master'
...
Component/bt: add readme doc for BLE demos
See merge request idf/esp-idf!4890
2019-06-26 16:04:28 +08:00
Angus Gratton
9bca2f878a
Merge branch 'feature/gcc_8_msys_update_simple' into 'master'
...
update MSYS package for esp32-2019r1 toolchain
See merge request idf/esp-idf!5199
2019-06-25 14:14:08 +08:00
Angus Gratton
a54a3fc92e
Merge branch 'bugfix/idfpy_print_filter' into 'master'
...
tools: Port the filtering option of IDF Monitor to the idf.py toolchain
Closes IDF-543
See merge request idf/esp-idf!4416
2019-06-25 13:36:03 +08:00
Hrishikesh Dhayagude
342f6a7829
Port NimBLE Host Stack on ESP-IDF
2019-06-25 09:03:58 +08:00
Angus Gratton
5cb71b5213
Merge branch 'feature/add_doc_about_app_desc_t' into 'master'
...
docs: Add description about the app image
Closes IDF-597
See merge request idf/esp-idf!4912
2019-06-24 18:40:02 +08:00
Konstantin Kondrashov
12a7d39ed6
docs: Add description
2019-06-24 12:33:33 +08:00