alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
13,557 Commits 20 Branches 148 Tags 384 MiB
6d5dc5def3
Commit Graph

1846 Commits

Author SHA1 Message Date
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
Angus Gratton
50fcdf115d doc builder: Change default to 1 job per Sphinx instance, add a warning 2020-02-07 16:37:44 +11:00
Anton Maklakov
a2516c6188 doc: Add a link to CN translation for power_management_esp32 2020-02-07 16:37:44 +11:00
Angus Gratton
35db219be2 docs: Manage parallel sphinx-build runs with optional parallel jobs within them 2020-02-07 16:37:44 +11:00
Marius Vikhammer
105567d077 doc: updated peripherals api-reference for s2 2020-02-07 16:37:44 +11:00
Marius Vikhammer
46dab1b4e8 doc: removed reference to idf_target in core dump title 2020-02-07 16:37:44 +11:00
Marius Vikhammer
83521dbc51 doc: Include paths for chip specific headers now depend on target 
Input for Doxygen now depend on idf_target for some paths, updated path name generated in run_doxygen.py to show the target dependent path.
 2020-02-07 16:37:44 +11: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
Marius Vikhammer
a7bac4721a doc: Add external ram note link to CN translation 2020-02-07 16:37:43 +11:00
Marius Vikhammer
d56ea52ea1 doc: EN doc update and fixed warnings 2020-02-07 16:37:43 +11:00
Marius Vikhammer
e06a57f34f doc: Changed toc filter reg.ex to be non-greedy 
Stops the parsing from crashing when the content contains a ":", e.g. in web-links
 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
Marius Vikhammer
c848aa74ac doc: Add extension that replaces generic target variable with idf_target 
Also changed event trigger for idf-extension to use config-updated, as this makes more logical sense

Includes functionality for defining local (single .rst file) substitution strings that depend on chip target.

Substitutions can be defined with {IDF_TARGET_X: default = "IO3", esp32 = "IO4"} and then used locally as {IDF_TARGET_X}

Also added global substitution for TRM links {IDF_TARGET_TRM_URL}
 2020-02-07 16:37:43 +11:00
Angus Gratton
1318623831 docs: Don't search in _static directories for rst files 2020-02-07 16:37:43 +11:00
Angus Gratton
d97b587871 docs: Clear _Static_assert related warnings 
Unclear why defining _Static_assert(x, y) in PREDEFINED list
doesn't match anything, but defining _Static_assert() does match.
 2020-02-07 16:37:43 +11:00
Angus Gratton
fdbcc12401 doc: Fix RMT waveform path warnings 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
a148d8e6ba docs: Refactor extensions into packages, update the add-ons-reference docs page 
Includes converting some of the remaining standalone scripts into Sphinx extensions.

Make flake8 clean
 2020-02-07 16:37:43 +11:00
Angus Gratton
cbede3a3a4 docs: Try to enable parallel reads & writes 
Reads still single threaded in Sphinx 1.8.5, though.
 2020-02-07 16:37:43 +11:00
Angus Gratton
d1373119e1 docs: Cleanup build warnings 2020-02-07 16:37:43 +11:00
Angus Gratton
b0748b4364 docs: Mark some more docs sections as ESP32 only 2020-02-07 16:37:43 +11:00
Angus Gratton
e753c1b509 docs: Edit out some unnecessary instances of "ESP32" in the doc text 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