Commit Graph

2071 Commits

Author SHA1 Message Date
Darian Leung
97721d469c TWAI: Add ESP32-S2 support
This commit adds TWAI driver support for the
ESP32-S2. The following features were added:

- Expanded BRP support
- Expanded CLKOUT Divider Support
- Updated example READMEs
2020-06-30 16:56:03 +08:00
Krzysztof Budzynski
eff2aa8094 Merge branch 'doc/restore_missing_zh_eth_guide' into 'master'
docs: restore chinese get-started-ethernet-kit guide

See merge request espressif/esp-idf!9368
2020-06-29 13:38:35 +08:00
Marius Vikhammer
e690b778a7 docs: restore chinese get-started-ethernet-kit guide
The chinese translation of get-started-ethernet-kit guide were erroneously
removed in commit 1a90470f02
2020-06-29 09:40:31 +08:00
Ivan Grokhotkov
5985c07ab7 docs: add section about USB CDC console 2020-06-26 15:38:49 +02:00
Wang Fang
256571a4f4 fix the formatting issues described in DOC-257 2020-06-24 02:47:12 +00:00
morris
a34409cffc esp_rom: extract common CRC apis into esp_rom_crc.h 2020-06-23 16:40:14 +08:00
Marius Vikhammer
32761b9782 docs: fix link_roles not linking correctly for certain files
Link_roles could link incorrectly if the name of a file matched the name of a submodule
2020-06-22 20:42:59 +08:00
Krzysztof Budzynski
4995fe510e Merge branch 'docs/saola_update' into 'master'
Add dimensions of ESP32-S2-Saola-1 User Guide

See merge request espressif/esp-idf!9249
2020-06-22 14:10:39 +08:00
Renz Bagaporo
3386316f81 docs: fix build issue requiring new location of cpu_start.c 2020-06-19 18:40:10 +10:00
Wang Ning
27f24a5d06 Add dimensions 2020-06-19 13:04:07 +08:00
Angus Gratton
b3ef89942f Merge branch 'feature/cmake_overriding_components_new_features' into 'master'
CMake: useful features for overriding components

See merge request espressif/esp-idf!8220
2020-06-19 11:56:56 +08:00
Renz Bagaporo
ebf07d353d cmake: allow overriding kconfig, kconfig_projbuild on registration 2020-06-16 20:42:00 +08:00
Renz Bagaporo
f8d0c5770b cmake: take note of component overriden dir 2020-06-16 20:42:00 +08:00
Krzysztof
1e34a1499b Resolve broken link reported on https://esp32.com/viewtopic.php?f=5&t=14148#p61447 by boarchuz 2020-06-15 21:34:11 +02:00
Krzysztof Budzynski
37beda489b Merge branch 'doc/get_started_duplicate_info' into 'master'
docs: remove English info from Chinese getting started guide

Closes DOC-213

See merge request espressif/esp-idf!9096
2020-06-15 02:36:59 +08:00
Krzysztof Budzynski
79a0e892a0 Merge branch 'feature/coredump_allow_variable_dumping' into 'master'
Added coredump user defined variable into coredump

Closes IDF-44

See merge request espressif/esp-idf!8730
2020-06-15 02:35:38 +08:00
Alexey Gerenkov
1deeadf4c5 Added coredump user defined variable into coredump 2020-06-15 02:35:38 +08:00
Angus Gratton
a171def1ba docs: Redirect all of Doxygen stderr to the warnings log
Some errors (for example the errors caused by macro values, as fixed in previous
commit) get logged to stderr even if WARN_LOGFILE is set, but Doxygen succeeds.
2020-06-12 14:30:47 +10:00
Angus Gratton
ea9322937f docs: Log the full list of macros, remove code-style macros to prevent Doxygen errors 2020-06-12 14:30:47 +10:00
Angus Gratton
7d989e08fd doc: Fix passing of build macros to Doxygen
Regression in fbb54184ef, the dictionary
passed to generate_doxygen function was still the project_description
structure.
2020-06-12 14:30:47 +10:00
Angus Gratton
eef0e178a0 Merge branch 'feature/msys2_env_update' into 'master'
windows: Update MSYS2 pre-compiled legacy build environment

Closes IDF-1289 and IDF-1526

See merge request espressif/esp-idf!9034
2020-06-12 07:26:09 +08:00
Krzysztof Budzynski
f17b4763e0 Merge branch 'doc/structures_enum4style_guide' into 'master'
Doc/structures enum4style guide

See merge request espressif/esp-idf!7140
2020-06-08 22:05:56 +08:00
Krzysztof Budzynski
d3a400c159 Merge branch 'feature/freertos_authentic_includes_docs' into 'master'
docs: Added ORIG_INCLUDE_PATH description to the doc

See merge request espressif/esp-idf!6889
2020-06-08 18:24:57 +08:00
Marius Vikhammer
ffd53d2329 docs: remove English info from Chinese getting started guide
The English text was a duplicate of the Chinese text and therefor unnecessary.

Closes DOC-213
2020-06-08 17:00:49 +08:00
Ivan Grokhotkov
7283b99c97 Merge branch 'feature/dfu_select_device' into 'master'
Add ability to select a device for DFU flashing

Closes IDF-1652

See merge request espressif/esp-idf!8956
2020-06-08 15:55:04 +08:00
kapil.gupta
179292f9b3 esp_wifi: Remove auth_changed event and fix wpa2 authmode threshold
Added following as part of this change
1. Removed auth_changed event
2. Updated doc regarding usage of  WPA/WEP secuiry modes
3. Fixed WPA2 enterprise authmode threshold.
2020-06-04 17:54:26 +05:30
Angus Gratton
9d52318683 Merge branch 'doc/ds_S2' into 'master'
DOC: DS documentation for S2

See merge request espressif/esp-idf!8450
2020-06-04 16:36:13 +08:00
Krzysztof Budzynski
cfadc65073 Merge branch 'docs/hal_and_ll' into 'master'
Add documentation about ESP-IDF Hardware Abstraction (HAL and LL)

Closes IDF-1198

See merge request espressif/esp-idf!9030
2020-06-04 16:33:40 +08:00
Darian Leung
e61bbbcb61 Add HAL and LL documentation
This commit adds docuemntation regarding Hardware
Abstraction in ESP-IDF.
2020-06-04 15:02:49 +08:00
Jakob Hasse
516680a4ff Doc: DS documentation for S2 2020-06-04 10:49:22 +08:00
Michael (XIAO Xufeng)
d2bb1e1b75 Merge branch 'bugfix/fix_adc_dac_driver_ut' into 'master'
Driver(adc): fix adc driver and UT

See merge request espressif/esp-idf!8482
2020-06-02 17:46:45 +08:00
Angus Gratton
0378b340b4 windows: Update MSYS2 pre-compiled legacy build environment
* Bundled with esp2020r2 toolchain
* Built with Python 3 & latest MSYS2 packages
2020-06-02 18:34:54 +10:00
Andrei Gramakov
d0f995c067 doc: added a component-specific property description for FreeRTOS: ORIG_INCLUDE_PATH 2020-06-01 15:49:52 +02:00
Andrei Gramakov
3e57b1c180 doc: Added enum and typedef conventions 2020-06-01 14:41:43 +02:00
fuzhibo
d90e0e4345 driver(adc): fix unit test for ADC-DMA (test_esp32s2.c); fix unit test for ADC-DMA (test_esp32s2.c); fix commit in adc dirver. 2020-06-01 15:00:08 +08:00
Marius Vikhammer
67ea59d605 docs: fix check_docs not working for multiple builders
When building docs with multiple builders the warning logs are now checked after
each run. Solves the issue where the logs would be overwritten by next builder before checking.

Closes IDF-1659
2020-05-29 20:10:18 +08:00
Angus Gratton
f64ae4fa99 efuse: Add 'disable Download Mode' & ESP32-S2 'Secure Download Mode' functionality 2020-05-28 17:50:45 +10:00
Roland Dobai
0ff8ec66e4 Add ability to select a device for DFU flashing 2020-05-28 09:31:35 +02:00
Krzysztof Budzynski
95ed99671b Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master'
espcoredump: apply documentation changes in core_dump.rst file

See merge request espressif/esp-idf!5697
2020-05-28 02:25:47 +08:00
Alex Lisitsyn
e649a4f017 espcoredump: apply temporary documentation changes in core_dump.rst file
added picture to describe bin and elf format of core dump
added link to core_dump_internals.rst file from main one
added the diagram to describe logic structure of core dump modules and dependencies
2020-05-28 02:25:46 +08:00
Natasha
5122e26090 Add translation for kaluga user guide 2020-05-26 14:54:45 +08:00
Angus Gratton
084e170a8f Merge branch 'refactor/esp_ipc' into 'master'
Split esp_ipc to a seaparate component

Closes IDF-1295

See merge request espressif/esp-idf!8520
2020-05-25 15:03:04 +08:00
Michael (XIAO Xufeng)
b3587ff88c Merge branch 'bugfix/fix_i2s_comm_format_unclear_description_bug' into 'master'
Bugfix(I2S):  Fix i2s_comm_format_t configuration parameter does not match the TRM bug

Closes IDFGH-3040, IDFGH-2913, IDFGH-578, IDFGH-2408, and IDFGH-3117

See merge request espressif/esp-idf!8339
2020-05-25 15:00:10 +08:00
Krzysztof Budzynski
9050f8a741 Merge branch 'feature/update_cloud_frameworks_doc' into 'master'
Update documentation for Cloud Frameworks

See merge request espressif/esp-idf!7572
2020-05-25 04:03:27 +08:00
Krzysztof Budzynski
56635f22b8 Merge branch 'doc/add_types_api_ref' into 'master'
doc: add peripheral_types.h as API reference for peripheral docs

Closes DOC-136 and IDF-1673

See merge request espressif/esp-idf!8528
2020-05-25 03:22:22 +08:00
Krzysztof Budzynski
fa0dd5cc7b Merge branch 'doc/view_github_link' into 'master'
docs: add 'edit-on-github' link to html theme

Closes IDF-1504

See merge request espressif/esp-idf!8629
2020-05-25 03:21:23 +08:00
Liu Han
e53c9300d6 docs: Update documentation for Cloud Frameworks 2020-05-24 19:06:59 +00:00
Krzysztof Budzynski
f1fac7dbfb Merge branch 'feature/docs_quick_links' into 'master'
docs: Provide link to ESP32-S2 specific documentation

See merge request espressif/esp-idf!8782
2020-05-25 02:59:36 +08:00
Krzysztof Budzynski
71d1b32dde docs: Provide link to ESP32-S2 specific documentation 2020-05-25 02:59:36 +08:00
Krzysztof Budzynski
6048791a1b Merge branch 'feature/doc_build_subset' into 'master'
docs: support building a subset of the documentation with build_docs

Closes IDF-1688

See merge request espressif/esp-idf!8857
2020-05-25 02:58:28 +08:00
Marius Vikhammer
a316082f53 docs: support building a subset of the documentation with build_docs
Closes IDF-1688
2020-05-22 15:01:40 +08:00
Island
3cea462c52 Merge branch 'doc/ble_mesh_fix' into 'master'
ble_mesh: Doc miscellaneous fixes

See merge request espressif/esp-idf!8847
2020-05-22 10:49:16 +08:00
Krzysztof Budzynski
1f18946ca0 Merge branch 'feature/new_camera_module_supported_on_esp32-s2-kaluga-1_board' into 'master'
docs: OV3660 camera module is now supported with ESP32-S2-Kaluga-1 Kit. Add...

See merge request espressif/esp-idf!8839
2020-05-21 22:05:46 +08:00
Krzysztof Budzynski
1b49a52edd docs: OV3660 camera module is now supported with ESP32-S2-Kaluga-1 Kit. Add link back to ESP-ADF documentation in ESP-LyraT-8311A user guide. 2020-05-21 22:05:45 +08:00
Mahavir Jain
6272cb842f Merge branch 'feature/esp_wroom32_se_example' into 'master'
Feature/esp wroom32 se example

See merge request espressif/esp-idf!8552
2020-05-21 19:51:19 +08:00
Aditya Patwardhan
423e600d46 secure_element: atecc608_ecdsa example
* Replaced crypotoauthlib with esp-cryptoauthlib
* Added menuconfig option for esp-tls about using HSM
* Added error codes for HSM in esp-tls,
* Added support to select different type of ATECC608A chips
* Added README, updated docs
* tcp_transport: Added option to enable secure_element for ssl

Closes https://github.com/espressif/esp-idf/issues/4432
2020-05-21 13:08:30 +05:30
lly
514ec37fe4 ble_mesh: Doc miscellaneous fixes
- Fix link error in getting started
- Update ble mesh architecture
2020-05-21 07:14:45 +00:00
Island
fbf2088fc8 Merge branch 'example/ble_mesh_structural_adjust' into 'master'
Example/ble mesh structural adjustment

Closes BLEMESH-200

See merge request espressif/esp-idf!8719
2020-05-21 15:11:23 +08:00
morris
d4c88e9e45 ci: add missing noqa:F401 2020-05-21 10:42:59 +08:00
Anton Maklakov
e1262aa68e Merge branch 'bugfix/gh_action_pass_IDF_PATH_to_pylint' into 'master'
gh_action: fix python lint

Closes IDF-1538 and IDFGH-3341

See merge request espressif/esp-idf!8812
2020-05-21 10:15:35 +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
lly
88eb4a0820 ble_mesh: Rename the folders ble_mesh_fast_prov_* to fast_prov_* 2020-05-20 11:33:46 +00: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
morris
d003f96a9d gh_action: fix python lint 2020-05-20 10:50:10 +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 Budzynski
45b59f134b Merge branch 'feature/another_python3_recomedation' into 'master'
Add another case and recomendation to use Python 3 instead of Python 2

Closes DOC-167

See merge request espressif/esp-idf!8733
2020-05-19 23:32:49 +08:00
Krzysztof Budzynski
e84328382f Merge branch 'doc/esp32_eco3_psram_note' into 'master'
docs: mention ESP32 ECO3 in relation to PSRAM cache workarounds

See merge request espressif/esp-idf!8796
2020-05-19 05:54:20 +08:00
houwenxiang
b35d9002f3 driver(I2S): Fix i2s_comm_format_t configuration parameter does not match the TRM bug.
When I2S `i2s_comm_format_t` is set to `I2S_COMM_FORMAT_I2S_MSB`, the data should launch at first BCK. But not in fact, this MR fixed this issue.

For compatibility, several nwe parameters have been added, and the old parameters will be removed in the future.

    closes https://github.com/espressif/esp-idf/issues/5065

    closes https://github.com/espressif/esp-idf/issues/4957

    closes https://github.com/espressif/esp-idf/issues/2978

    closes https://github.com/espressif/esp-idf/issues/5136

    Merges https://github.com/espressif/esp-idf/pull/4522
2020-05-18 19:55:30 +08:00
Ivan Grokhotkov
e4e51fd97a docs: mention ESP32 ECO3 in relation to PSRAM cache workarounds 2020-05-18 13:45:17 +02:00
Kirill Chalov
c65c1716cd Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit
QR codes have already been issued for user-guide-kaluga-1-v1.2 and the links there are not working now. Add a redirect.
2020-05-18 17:28:03 +08:00
Darian Leung
11d96b39d0 esp_ipc: Move to new component
This commit moves esp_ipc into a separate component.
2020-05-18 16:51:45 +08:00
Krzysztof Budzynski
58a9db8492 Merge branch 'feature/smartconfig_links' into 'master'
Provide a brief description of SmartConfig and add link to example

See merge request espressif/esp-idf!8636
2020-05-18 01:02:05 +08:00
Krzysztof Budzynski
e58c0ac3e7 Provide a brief description of SmartConfig and add link to example 2020-05-18 01:02:04 +08:00
Krzysztof Budzynski
817a41ce9e Merge branch 'bugfix/doc_dfu_update' into 'master'
Update DFU flashing documentation with fixes and known issues

Closes IDF-1686

See merge request espressif/esp-idf!8728
2020-05-15 23:10:11 +08:00
Krzysztof Budzynski
ad9e514ff4 Merge branch 'doc/documenting_code_format_fix' into 'master'
docs: change descriptions of substitution defines to use literal blocks

See merge request espressif/esp-idf!8699
2020-05-14 15:03:41 +08:00
Krzysztof
789c42abcd Add another case and recomendation to use Python 3 instead of Python 2 2020-05-13 21:57:51 +02:00
Roland Dobai
6aaff0887b Update DFU flashing with fixes and known issues 2020-05-13 15:40:55 +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
Marius Vikhammer
6d56ac8b84 docs: change descriptions of substitution defines to use literal blocks
Copy-pasting the "local substitution" example would result in an error,
due to the ASCII quotation marks being replaced by unicode double quotation marks
when outputting the HTML.
2020-05-12 11:32:34 +08:00
Wang Ning
8b8d03f7bd Update Build and Flash with Eclipse IDE to make terminology consistent 2020-05-11 16:51:30 +08:00
Marius Vikhammer
27fa1dc0dd doc: add peripheral_types.h as API reference for peripheral docs
Closes DOC-136
Closes IDF-1673
2020-05-11 11:20:39 +08:00
Krzysztof Budzynski
e30185c166 Merge branch 'docs/fix_oocd_debug_level_opt' into 'master'
docs: Fixes OpenOCD debug level option

See merge request espressif/esp-idf!8646
2020-05-08 16:31:36 +08:00
Krzysztof Budzynski
f318dab0ad Merge branch 'doc/review_security-flash-encryption' into 'master'
Review security/flash-encryption.rst

See merge request espressif/esp-idf!7672
2020-05-08 03:31:29 +08:00
Alexey Gerenkov
b441df7cf1 docs: Fixes OpenOCD debug level option 2020-05-07 16:02:13 +03:00
Valerii Koval
bc397f8b7d Add new section about using ESP-IDF with PlatformIO
This adds a description of PlatformIO ecosystem, tutorials, examples

Merges https://github.com/espressif/esp-idf/pull/5132
2020-05-06 12:55:22 +02:00
Marius Vikhammer
214f1fbbed docs: add 'edit-on-github' link to html theme
Closes IDF-1504
2020-05-06 17:25:23 +08:00
Krzysztof Budzynski
9b309a0a97 Merge branch 'bugfix/doc_fix_dfu' into 'master'
docs: Fix and extend the DFU documentation page

See merge request espressif/esp-idf!8602
2020-05-06 05:17:12 +08:00
Ivan Grokhotkov
b0f448a972 Merge branch 'feature/console_no_empty_lines' into 'master'
console: allow not returning empty lines (Github PR)

Closes IDFGH-2869

See merge request espressif/esp-idf!8232
2020-05-05 16:12:50 +08:00
Roland Dobai
00d638f4d6 docs: Fix and extend the DFU documentation page 2020-05-04 18:02:01 +02:00
Felipe Neves
6f5e43e26a heap: added alloc failed hook and configuration options
heap/test: added alloc failed hook tests

docs: added alloc failed hook documentation

heap: add function to register allocation failed hook

docs: allocation failed hook docs improvements
2020-05-04 10:58:38 -03: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
Angus Gratton
f9552baf97 Merge branch 'feature/dfu_build_flash_s2' into 'master'
Add build system support for programming ESP32-S2 using DFU utils

Closes IDF-579

See merge request espressif/esp-idf!8294
2020-05-04 14:57:51 +08:00
Krzysztof Budzynski
39c5db4c38 Merge branch 'bugfix/make_docs_ldgen' into 'master'
docs: remove quotes in ldgen documentation for adding fragment file

See merge request espressif/esp-idf!8501
2020-05-04 03:22:59 +08:00
Wang Ning
158945aebf Add translation for modules-and-boards 2020-04-30 18:50:36 +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
ece41b04e3 console: make empty line behavior run-time configurable 2020-04-29 23:44:46 +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
Krzysztof Budzynski
4d53c137e6 Merge branch 'doc/pdf_rm_link_translation' into 'master'
doc: remove links to translation if building PDF

Closes IDF-1579

See merge request espressif/esp-idf!8455
2020-04-29 16:47:06 +08:00
Renz Bagaporo
aed204ce6f cmake: allow embedding to depend on a target 2020-04-29 12:34:25 +08:00
Felipe Neves
c78ddb770a docs: added information of task states on fatal errors documentation. 2020-04-27 14:41:55 +00:00
Krzysztof Budzynski
c5c026557e Merge branch 'doc/hmac_S2' into 'master'
Doc: Documentation for HMAC module

See merge request espressif/esp-idf!8383
2020-04-27 19:03:01 +08:00
Renz Bagaporo
da91172616 docs: remove quotes in ldgen documentation for adding fragment file
Closes https://github.com/espressif/esp-idf/issues/5142
2020-04-27 15:22:38 +08:00
Michael (XIAO Xufeng)
9d98111652 Merge branch 'bugfix/spi_bus_lock_missing_semphrstatic' into 'master'
spi: fix config break and reduce overhead of the bus lock on SPI1

Closes IDFGH-3017

See merge request espressif/esp-idf!8221
2020-04-27 12:57:19 +08:00
Jakob Hasse
2da7e65646 Doc: S2 HMAC documentation 2020-04-27 12:25:46 +08:00
lly
2f6a4140fa doc: Fix some ble mesh description 2020-04-26 06:22:33 +00:00
Marius Vikhammer
dc2c753a7d doc: remove links to translation if building PDF
Closes IDF-1579
2020-04-23 18:59:37 +08:00
Michael (XIAO Xufeng)
7ec4d64b80 spi: Update documents about the bus lock and how to use SPI Master on SPI1 bus 2020-04-23 12:27:25 +08:00
Krzysztof Budzynski
0842aed2bc Merge branch 'doc/submodule_links' into 'master'
doc: roles for linking files now correctly links to submodule repositories

Closes IDF-1584

See merge request espressif/esp-idf!8405
2020-04-22 01:49:18 +08:00
Angus Gratton
2433fe664d Merge branch 'doc/wdt_config' into 'master'
docs: Add details about WDT config

See merge request espressif/esp-idf!7838
2020-04-21 11:51:42 +08:00
Marius Vikhammer
e7d92b857e doc: roles for linking files now correctly links to submodule repositories
Closes IDF-1584
2020-04-20 15:59:41 +08:00
Krzysztof Budzynski
e45794d0cb Merge branch 'doc/pdf_generation' into 'master'
PDF generation for build doc

Closes IDF-1217 and IDF-1464

See merge request espressif/esp-idf!8110
2020-04-20 01:44:42 +08:00
Krzysztof Budzynski
412c43d9b9 Merge branch 'docs/saola-1-guide' into 'master'
Add links to translation in Saola board user guide

See merge request espressif/esp-idf!8124
2020-04-15 22:23:27 +08:00
Wang Ning
efba523b54 Add links to translation in Saola board user guide 2020-04-15 22:23:26 +08:00
Marius Vikhammer
8a3d806798 doc: update CI to build PDF 2020-04-15 17:14:27 +08:00
Marius Vikhammer
407275f681 doc: add latex and PDF generation to build_docs
Adds options for generating tex-files and PDFs when building documentation

Closes IDF-1217
Closes IDF-1464
2020-04-15 17:14:22 +08:00
Wang Ning
6d3f35f651 Fix a typo error based on DOC-111 2020-04-15 09:08:43 +00:00
Angus Gratton
b18ce2f686 doc: Add configuration information about INT & Task WDTs 2020-04-15 17:30:05 +10:00
Fu Hanxi
5b2fa1a5ad build_app: make multi target support readable 2020-04-09 16:40:57 +08:00
Angus Gratton
8ded54a65d Merge branch 'feature/easy_debug' into 'master'
idf.py: add debug related targets

Closes IDF-890

See merge request espressif/esp-idf!5602
2020-04-08 16:08:10 +08:00
Ivan Grokhotkov
651dbe48e7 Merge branch 'feature/gcovr' into 'master'
app_trace: Add coverage generations by gcovr

Closes IDF-780

See merge request espressif/esp-idf!8168
2020-04-08 15:57:08 +08:00
Marius Vikhammer
d193790f85 doc: update flash encryption with S2 specific content 2020-04-08 11:17:31 +08:00
Kirill Chalov
0cc9ffb8f7 Implement comments and add info on ESP32S2 2020-04-08 10:30:22 +08:00
Kirill Chalov
9ed60af1f2 Review security/flash-encryption.rst 2020-04-08 10:30:22 +08:00
David Cermak
3b5c3d6521 idf.py: debug targets for easier execution of openocd, gdb, gdbui
Support for execution of asynchronous target, such as openocd, which
by default runs in the background, but if it's the only target idf.py
outputs the openocd in the console waiting for termination by user.

Supports also blocking commands gdb and gdbtui to start a debugging
session in an active console.

Supports running gdbgui running a UI debugging session in a browser
window, using the active console for other commands, such as openocd
or monitor.

Supports combining the debug targets in one action list, such as
idf.py openocd gdbgui monitor
2020-04-07 17:37:48 +02:00
Renz Bagaporo
07f9978df7 cmake: add elf dir information
Solves https://www.esp32.com/viewtopic.php?f=13&t=14784&p=57557&hilit=assumes#p57557
2020-04-07 17:19:33 +08:00
Anton Maklakov
fa3131b870 Merge branch 'bugfix/bash_bin_env' into 'master'
global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs

Closes IDFGH-708

See merge request espressif/esp-idf!8235
2020-04-06 17:51:43 +08:00
Ivan Grokhotkov
e94288da31 global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs
Using the method from @cemeyer
(https://github.com/espressif/esp-idf/pull/3166):

find . -name \*.sh -exec sed -i "" -e 's|^#!.*bin/bash|#!/usr/bin/env bash|' {} +

Closes https://github.com/espressif/esp-idf/pull/3166.
2020-04-03 01:10:02 +02:00
Krzysztof Budzynski
7a92dd431f Merge branch 'bugfix/partition_types_cxx' into 'master'
docs: Explain custom partition types/subtypes in more detail

Closes IDFGH-2882

See merge request espressif/esp-idf!8192
2020-04-02 21:52:52 +08:00
Michael (XIAO Xufeng)
15026d1b84 Merge branch 'bugfix/fix_adc_driver_for_esp32s2' into 'master'
Bugfix/fix adc driver for esp32s2

Closes IDF-1448, IDF-1449, IDF-1450, IDF-1451, and IDF-1458

See merge request espressif/esp-idf!7776
2020-04-02 11:02:21 +08:00
Angus Gratton
d76bf19ffd docs: Explain custom partition types/subtypes in more detail
Including how to use with C++ (closes https://github.com/espressif/esp-idf/pull/1832)
2020-04-02 10:00:17 +11:00
Krzysztof Budzynski
8210802703 Merge branch 'bugfix/expand_defines_dict' into 'master'
doc: fix defines dict expansion

See merge request espressif/esp-idf!8169
2020-04-01 20:36:12 +08:00
Mahavir Jain
05d95c0e7e Merge branch 'bugfix/esp_http_server_docs' into 'master'
Fixed syntax error in esp_http_server.rst

See merge request espressif/esp-idf!8170
2020-04-01 17:48:16 +08:00
Angus Gratton
4358f3b573 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-01 17:36:08 +11:00
fuzhibo
baa7898e35 driver(adc/dac): fix adc dac driver for esp32s2
1. update register file about adc; 2. fix adc driver; 3. add UT for adc/dac;

See merge request espressif/esp-idf!7776
2020-04-01 12:41:51 +08:00
morsisko
9759aa4ad2 Fixed syntax error in esp_http_server.rst
Merges: https://github.com/espressif/esp-idf/pull/5021
2020-03-31 14:59:27 +00:00
Roland Dobai
26695df5c8 app_trace: Add coverage generation by gcovr 2020-03-30 13:34:06 +02:00
morris
17b90afcab doc: fix defines dict expansion 2020-03-30 18:26:37 +08:00
Angus Gratton
fe64ab6de0 docs: secure boot v2: Add a note about maximum bootloader size 2020-03-30 18:13:42 +11:00
Angus Gratton
142f69448f secure boot v2: esp32: Prevent read disabling additional efuses
Also reduce the number of eFuse write cycles during first boot when
Secure Boot and/or Flash Encryption are enabled.
2020-03-30 18:00:40 +11:00
Krzysztof Budzynski
82e2b4a0d4 Merge branch 'docs/add_translation_for_7637' into 'master'
Add translation for the update in 7637 and 8095

See merge request espressif/esp-idf!8059
2020-03-30 06:43:01 +08:00
Krzysztof Budzynski
de74cfdcad Merge branch 'doc/ethernet_api_reference' into 'master'
add Ethernet API reference

Closes IDF-911

See merge request espressif/esp-idf!7270
2020-03-30 02:04:53 +08:00
Krzysztof Budzynski
6aa3179d71 Merge branch 'doc/feedback_target_exact_version' into 'master'
doc: Add exact git version & target SoC to feedback form parameters

See merge request espressif/esp-idf!8123
2020-03-30 01:20:46 +08: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
Angus Gratton
ef7ebbe39c doc: Add exact git version & target SoC to feedback form parameters
Currently squeezed into the "version" field as we don't have separate fields for these.
2020-03-27 11:29:59 +11:00
Angus Gratton
02fe8fb1eb Merge branch 'bugfix/monitor_encrypted_target' into 'master'
tools: Fix flashing encrypted binaries from IDF Monitor

Closes IDF-822

See merge request espressif/esp-idf!8090
2020-03-27 08:11:38 +08:00
morris
279e8dd6c2 add Ethernet doc 2020-03-26 11:04:55 +00:00
Wang Ning
a0c37ae1bd Add ESP32-S2-Saola-1 User Guide 2020-03-26 18:40:05 +08:00
Wang Fang
d10e24fb94 Update toolchain xtensa-esp-elf to xtensa-esp32-elf by modifying the dict TOOLCHAIN_NAMES 2020-03-26 18:15:37 +08:00
Roland Dobai
9b16594444 tools: Fix flashing encrypted binaries from IDF Monitor 2020-03-26 07:51:59 +01:00
Angus Gratton
928fc0016c Merge branch 'bugfix/doc_soc_caps_file_path' into 'master'
doc: correct soc caps file path

See merge request espressif/esp-idf!8097
2020-03-26 10:32:12 +08:00
Michael (XIAO Xufeng)
826cc7ecb6 Merge branch 'feature/bringup_723_cmake_rmt_driver_update' into 'master'
RMT new features in ESP32S2

Closes IDF-1286

See merge request espressif/esp-idf!7401
2020-03-26 10:24:18 +08:00
Wang Ning
168a623a07 Add translation for linker script generation 2020-03-26 00:48:58 +08:00
Wang Ning
3784d499af Add translation for ota tool and partation tool 2020-03-25 21:44:33 +08:00
Krzysztof Budzynski
de1f56466b Merge branch 'bugfix/doc_redirects' into 'master'
doc: Create redirects for ESP32 hw-reference get-started URLs

Closes IDF-1503

See merge request espressif/esp-idf!8094
2020-03-25 17:34:19 +08:00
morris
9f035edb64 rmt: update doc 2020-03-25 17:14:00 +08:00
morris
0c17af3ea4 rmt: support tx loop count 2020-03-25 17:14:00 +08:00
morris
855b316045 rmt: better support rx demodulation 2020-03-25 13:19:03 +08:00
morris
b5ab764f82 doc: correct soc caps file path 2020-03-24 19:11:28 +08:00
Angus Gratton
520802d6cb doc: Rephrase the support for ESP32 & ESP32-S on the home page 2020-03-24 15:00:27 +11:00
Angus Gratton
3dec957bc8 doc: Create redirects for ESP32 hw-reference get-started URLs
Moved in 1a90470f02 but redirects not created
2020-03-24 14:56:12 +11:00
Ivan Grokhotkov
35560cb538 Merge branch 'doc/fix_example_links' into 'master'
doc: Fix invalid links

Closes DOC-67 and DOC-69

See merge request espressif/esp-idf!8065
2020-03-23 21:17:20 +08:00
Angus Gratton
52d888a68b docs: Fix broken URLs & permanent redirects 2020-03-23 18:11:23 +11:00
Angus Gratton
a6b522c0f4 docs: Fix generation of links to examples 2020-03-23 18:11:23 +11:00
Angus Gratton
b4d97a8076 Merge branch 'feature/add_heap_info_per_task_example' into 'master'
Add Task Heap Tracking example

See merge request espressif/esp-idf!7750
2020-03-23 14:07:00 +08:00
Angus Gratton
111f596275 Merge branch 'bugfix/doc_build_ut_cmdline' into 'master'
docs: Fixup format of a command line to build unit tests

See merge request espressif/esp-idf!8033
2020-03-23 13:43:42 +08:00
Angus Gratton
bd827a4d2f Merge branch 'doc/small_fixes' into 'master'
doc: Two small fixes

See merge request espressif/esp-idf!8050
2020-03-23 08:06:07 +08:00
Angus Gratton
5fbf95d691 docs: Expand the description of per-target custom macro directives 2020-03-20 19:57:18 +11:00
Angus Gratton
e5410450be docs: Fix the secure-boot page redirect 2020-03-20 19:07:09 +11:00
Anton Maklakov
8046df875e docs: Fixup format of a command line to build unit tests 2020-03-19 19:28:46 +07:00
Shubham Kulkarni
6e09056c25 example: Add Heap Task Tracking example 2020-03-19 15:07:41 +05:30
David Čermák
1d3dbb239a Merge branch 'feature/ws_server' into 'master'
http_server: adds WebSocket support

Closes IDFGH-2151 and IDFGH-2752

See merge request espressif/esp-idf!7893
2020-03-19 17:20:56 +08:00
Angus Gratton
207914a13a Merge branch 'refactor/common_code_panic_handler' into 'master'
Panic handling common code refactor

See merge request espressif/esp-idf!7489
2020-03-19 11:23:57 +08:00
David Cermak
0c13082b20 http_server docs: document websocket feature and corresponding example 2020-03-18 20:24:46 +00:00
Natasha
ee0ae607da Add translation for mesh document under api guide 2020-03-17 01:02:36 +08:00
Mahavir Jain
88fd09111c Merge branch 'feature/prov_example_restructure' into 'master'
wifi_provisioning: Example restructuring

See merge request espressif/esp-idf!6901
2020-03-16 15:38:11 +08: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
Angus Gratton
cb7f2d737a docs: Bump copyright date to 2020 2020-03-16 14:36:23 +11:00
Angus Gratton
e0eb218e7a docs: Add a note about what target this doc version is for 2020-03-16 14:36:23 +11:00
Angus Gratton
296a1db3c6 docs: Update link_to_translation to work with targets & new URL scheme
Main difference is using app config for version & target

Also made this code less generic, easier to understand
2020-03-16 14:36:23 +11:00
Angus Gratton
1a2ddcb77a docs: deploy docs to production server from CI 2020-03-16 14:36:23 +11:00
Angus Gratton
416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-03-16 14:36:23 +11:00
Piyush Shah
156ae68275 provisioning_examples: Move older examples to legacy/ folder
Change the manager example folder name to wifi_prov_mgr to sound more meaningful.

Signed-off-by: Piyush Shah <piyush@espressif.com>
2020-03-13 06:23:15 +00:00
Wang Ning
b85358e593 Updated index
components/esp_wifi/lib_esp32/
2020-03-11 06:43:31 +08:00
Renz Christian Bagaporo
20cfc2ecdd docs: update docs with panic handler changes 2020-03-10 19:56:24 +08:00
Krzysztof Budzynski
37997407df Merge branch 'doc/review_api-ref_periph-esp-slave-protocol' into 'master'
Doc/review api ref periph esp slave protocol

See merge request espressif/esp-idf!6968
2020-03-09 19:19:01 +08:00
morris
46ea7d815d parttool: don't print target name 2020-03-09 15:05:04 +08:00
Angus Gratton
a9854f7085 Merge branch 'feature/rmt_clock_support_ref_tick' into 'master'
rmt: support ref tick && refactor unit test && re-enable unit test on ESP32-S2

Closes IDFGH-1715

See merge request espressif/esp-idf!7614
2020-03-06 15:03:52 +08:00
Angus Gratton
b393203b27 Merge branch 'feature/x509_cert_management' into 'master'
X509 certificate management

Closes IDF-296

See merge request espressif/esp-idf!5346
2020-03-06 14:29:53 +08:00
Krzysztof Budzynski
2178e3fba4 docs: Update getting started guide for ESP32-S2 target 2020-03-05 05:05:23 +08:00
Marius Vikhammer
947e3e94ed Add ESP certificate bundle feature
Adds the ESP certificate bundle feature that enables users to bundle a
root certificate bundle together with their application.

Default bundle includes all Mozilla root certificates

Closes IDF-296
2020-03-04 10:51:43 +08:00
Angus Gratton
3490c14298 Merge branch 'doc/multi_target_inc_dir' into 'master'
docs: multi target include dir support

Closes IDF-1371

See merge request espressif/esp-idf!7763
2020-03-04 07:35:10 +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
morris
0e4d82bc55 rmt: support REF_TICK as channel clock source
Closes https://github.com/espressif/esp-idf/pull/3952
2020-03-03 20:14:46 +08:00
Kirill Chalov
b2d38cf324 Review the file api-reference/peripherals/esp_slave_protocol.rst 2020-03-03 18:12:56 +08:00
Marius Vikhammer
9b56892bfe doc: fix broken .. only:: in JTAG guide
Added note about .. only:: limitations to guide
2020-03-03 15:30:37 +08:00
Marius Vikhammer
c26a765a37 doc: remove uncessary .. only:: dirs
Removed some only directives that are no longer needed with include being processed correctly
2020-03-03 11:37:42 +08:00
Marius Vikhammer
dfc95bc78b docs: multi target include dir support
Closes IDF-1371

Added an include directive that allows for the content to be formatted
according to idf target
2020-03-03 11:37:42 +08:00
Angus Gratton
6f7be93d53 Merge branch 'bugfix/cmake_convert_whitespace' into 'master'
cmake: Minor convert_to_cmake.py fixes

See merge request espressif/esp-idf!7066
2020-03-02 14:22:37 +08:00
Angus Gratton
8887f79bef cmake: Add warnings that convert_to_cmake.py doesn't calculate component requirements
Any component which requires another component will need this manually
added to its CMakeLists.txt file.
2020-03-02 14:45:03 +11:00
Krzysztof Budzynski
bd220bb578 Correct ULP REG_WR and REG_RD instruction for ESP32 and ESP32-S2.
Closes https://github.com/espressif/esp-idf/issues/4776
2020-03-02 04:18:44 +08:00
Krzysztof Budzynski
0ec526444a docs: Include feedback link in footer 2020-02-29 16:20:41 +08:00
Angus Gratton
f96c374254 Merge branch 'doc/multi_target_list' into 'master'
doc: custom list filter directive

Closes IDF-1385

See merge request espressif/esp-idf!7595
2020-02-28 11:57:55 +08:00
Mahavir Jain
5f897fd33c Merge branch 'feat/secure_boot_v2_v41' into 'master'
feat/secure_boot_v2: Adding secure boot v2 support to ESP32-ECO3

Closes IDF-799

See merge request espressif/esp-idf!6778
2020-02-27 18:54:08 +08:00
lly
7cd08b5824 ble_mesh: Miscellaneous modifications
1. Add an API to set Provisioner static oob value
2. Add an API to deinit BLE Mesh stack
3. Add an API to set Provisioner unicast address
4. Add an API to provision devices with fixed address
5. Add an API to store node composition data
6. Add an API to get node with device uuid
7. Add an API to get node with unicast address
8. Add an API to delete node with device uuid
9. Add an API to delete node with unicast address
10. Add an API for Provisioner to update local AppKey
11. Add an API for Provisioner to update local NetKey
12. Support Provisioner persistent functionality
13. Fix Provisioner entering IV Update procedure
14. Fix an issue which may cause client failing to send msg
15. Use bt_mesh.flags to indicate device role
16. Remove several useless macros
17. Callback RSSI of received mesh provisioning packets
18. Modify the Provisioner disable function
19. Change some log level from debug to info
20. Add parameters to Provisioner bind AppKey completion event
21. Fix node ignoring relay messages issue
22. Support using a specific partition for BLE Mesh
23. Fix compile warning when proxy related macros are disabled
24. Clean up BLE Mesh stack included header files
25. NULL can be input if client message needs no parameters
26. Fix compile warning when BT log is disabled
27. Initilize BLE Mesh stack local variables
28. Support using PSRAM for BLE Mesh mutex, queue and task
29. Add a menuconfig option to enable using memory from PSRAM
30. Clean up sdkconfig.defaults of BLE Mesh examples
2020-02-26 17:37:44 +08:00
Supreet Deshpande
073ba0a608 feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 2020-02-25 01:28:22 +05:30
Roland Dobai
5c0cd9417d Docs: Encourage to used Python 3 2020-02-24 12:55:55 +01:00
Ivan Grokhotkov
996c925d29 Merge branch 'doc/tools_docker_bind_kconfig' into 'master'
docs: docker: add instructions for binding tools/kconfig to a volume

See merge request espressif/esp-idf!7655
2020-02-21 09:57:21 +08:00
Marius Vikhammer
63b76a9d90 doc: custom list filter directive
Custom directive that allows for creation of lists where the content can be filtered based on target.

Closes IDF-1385
2020-02-20 18:08:05 +08:00
Angus Gratton
3b498a0576 Merge branch 'bugfix/confserver_hex_types' into 'master'
confserver: Standardize and document the handling of hex values

See merge request espressif/esp-idf!7437
2020-02-20 14:48:15 +08:00
Ivan Grokhotkov
fe0df01b12 Merge branch 'bugfix/from_github' into 'master'
Fixes from Github

Closes IDFGH-2679, IDFGH-2632, IDFGH-2716, IDFGH-2439, and IDFGH-2509

See merge request espressif/esp-idf!7659
2020-02-18 23:53:38 +08:00
Ivan Grokhotkov
75d0f38108 Merge branch 'doc/unit_test_multiple_targets' into 'master'
doc: add multi-target rules for writing unit tests

See merge request espressif/esp-idf!7438
2020-02-18 23:30:02 +08:00
Ivan Grokhotkov
20d93ac835 docs: remove note about v4.0 docker tag, use release-v4.0 as example 2020-02-18 14:02:46 +01:00
Rusty Eddy
a81d231791 Added semi-colon to esp_event_loop_create(...)
Title sums it up.

Merges https://github.com/espressif/esp-idf/pull/4711
2020-02-18 12:30:38 +01:00
Mooli Tayer
311983eb55 Fix typo
Merges https://github.com/espressif/esp-idf/pull/4752
2020-02-18 12:30:29 +01:00
Ivan Grokhotkov
9be3cd883b docs: docker: add instructions for binding tools/kconfig to a volume
Closes https://github.com/espressif/esp-idf/issues/4790
2020-02-18 11:43:29 +01:00
Jakob Hasse
7e7f87a70d DOC: fixed MR regression leading to doc build error 2020-02-18 09:01:33 +01:00
Angus Gratton
e95ba301d8 Merge branch 'bugfix/use_quotes_in_embedding_ulp_apps' into 'master'
ulp: use quotes when specifying files for embedding ulp binaries

See merge request espressif/esp-idf!7606
2020-02-18 09:15:50 +08:00
Renz Christian Bagaporo
bb639bb91d ulp: use quotes when specifying files for embedding ulp binaries 2020-02-18 00:12:56 +00:00
Angus Gratton
99cdddeb63 docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-18 10:34:11 +11:00
Angus Gratton
a825985283 docs: Check local files exist (and are correct type) for custom link roles 2020-02-18 10:34:11 +11:00
Angus Gratton
d9d7a906b1 confserver docs: Merge the build-system docs info about confserver into the README
Add link into the README from the docs
2020-02-17 17:21:22 +11:00
Krzysztof Budzynski
41bc06b9b9 Merge branch 'bugfix/docs_ledc' into 'master'
drivers: Remove high speed mode from LEDC docs for ESP32-S2, update headers to match

See merge request espressif/esp-idf!7532
2020-02-17 05:00:36 +08:00
Tian Yang Min
63ed8a4aed docs: Add Chinese translation for esp-ble-mesh-faq
This commit adds the Chinese translation for the
esp-ble-mesh-faq document.
2020-02-17 04:58:56 +08:00
Michael (XIAO Xufeng)
699c6db836 doc: add multi-target rules for writing unit tests 2020-02-14 14:54:30 +08:00
Ivan Grokhotkov
8d8337e80c Merge branch 'feat/sdspi_polling_spi' into 'master'
sdspi: allow using sdspi with other devices on the same bus

See merge request espressif/esp-idf!3177
2020-02-13 15:18:59 +08:00
Angus Gratton
d8a4159a83 Merge branch 'bugfix/build_docs_add_warning_check' into 'master'
bugfix/build_docs_add_warning_check: Added null value check for warnings

See merge request espressif/esp-idf!7556
2020-02-12 16:27:07 +08:00
Michael (XIAO Xufeng)
067f3d21c9 sdspi, vfs_fat: allow sharing SPI bus among devices, and mounting multiple SD cards 2020-02-12 15:16:08 +08:00
Supreet Deshpande
ef7b5ff9e4 bugfix/build_docs_add_warning_check: Added null value check for warnings 2020-02-12 12:32:41 +05:30
Angus Gratton
c1d0daf36d Merge branch 'refactor/restructure_soc_component' into 'master'
soc: separate abstraction, description and implementation

See merge request espressif/esp-idf!7261
2020-02-12 07:50:10 +08:00
Ivan Grokhotkov
700161921c docs: update version of IDF tools installer for windows to v2.3 2020-02-11 19:05:17 +01:00
Renz Christian Bagaporo
1f2e2fe8af soc: separate abstraction, description and implementation 2020-02-11 14:30:42 +05:00
Angus Gratton
ea34f3bb27 drivers: Remove high speed mode from LEDC docs for ESP32-S2, update headers to match 2020-02-11 14:36:47 +11:00
suda-morris
75cadc2e41 console: simplify examples
1. simplify console examples
2. add "quit" command
3. support console command overwrite
4. add API reference
2020-02-07 20:15:06 +08:00
Angus Gratton
2c03d2cc4e docs: Re-run the 'set-target' target each time, use a unique sdkconfig file for each lang/target combo
Fixes some problems with CMake errors in stale builds, and of sdkconfig file being shared between
parallel jobs.
2020-02-07 16:47:50 +11:00
Angus Gratton
54e7cb4d8b docs: Require UTF-8 as default encoding to build docs
Making everything work for both docs & non-docs builds with Py2 is too fiddly otherwise.
2020-02-07 16:47:50 +11:00
Angus Gratton
291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +11:00
Angus Gratton
4636e8a34c docs/documenting-code: Add a couple of follow up notes on top of last commit 2020-02-07 16:37:45 +11:00
Marius Vikhammer
9f617c7874 docs: Add a short user guide for how to write multi target docs 2020-02-07 16:37:45 +11:00
Angus Gratton
d03af45731 docs: flake8 fixes 2020-02-07 16:37:45 +11:00
Angus Gratton
eb85cfb9f6 docs: Temporarily mark RF calibration chapter as ESP32 only
Can be re-enabled once ESP32-S2 calibration support is added
2020-02-07 16:37:45 +11:00
Angus Gratton
4bfd004c83 build_docs gh-linkcheck: Use Python, ignore links to master branch SUPPORT_POLICY.md 2020-02-07 16:37:45 +11:00
Anton Maklakov
775448c792 docs: Make Python 3 compatible 2020-02-07 16:37:45 +11:00
Angus Gratton
50324b505d docs: Note that the idf target formatting filters don't work on "included" documents 2020-02-07 16:37:45 +11:00
Angus Gratton
740d422134 docs: Possible fix for blockdiag & seqdiag UnicodeEncodeErrors 2020-02-07 16:37:45 +11:00
Angus Gratton
844bdd8154 docs: Allow incremental builds 2020-02-07 16:37:45 +11:00
Angus Gratton
11fac8637a docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
Marius Vikhammer
268816649c Replace all TRM urls will generic template variable and remove duplicate sections
All references to TRM had the section duplicated for both targets using .. only:: , replaced these with a generic template url
2020-02-07 16:37:45 +11:00
Anton Maklakov
b9effd8c06 fixup build_docs.py, show doxygen and sphinx warnings together 2020-02-07 16:37:44 +11:00
Anton Maklakov
fb3edc9c87 docs: Add features to build_docs.py: check warnings, check links, check GH links
The old check_doc_warnings.sh was deleted
2020-02-07 16:37:44 +11:00