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
29,662 Commits 20 Branches 148 Tags 384 MiB
0f781c718c
Commit Graph

169 Commits

Author SHA1 Message Date
Armando
d41da2792a doc: add flash and psram configuration doc in programming guide 2021-10-26 11:49:36 +08:00
Marius Vikhammer
1cf61c849f docs: enable publishing of S3 docs 2021-09-06 09:11:17 +08:00
Darian Leung
963836f491 Add USB Host Library API docs 
- This commit adds the API documentation for the USB Host Library.
- Warnings about the beta API are also added.
- usb_host_misc.h renamed to usb_helpers.h
 2021-09-02 18:40:24 +08:00
Marius Vikhammer
8b38e9ecf5 docs: fix edit on github link to point to esp-idf 
Also add check for IDF_PATH for better error feedback
 2021-08-24 17:54:48 +08:00
Marius Vikhammer
7411321603 docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
Jakob Hasse
1c3be690ed [esp_hw_support]: HMAC upstream support for S3 2021-08-13 12:01:06 +08:00
morris
2218204aa7 doc: update tinyusb document to support esp32s3 
1. Renamed SOC_USB_SUPPORTED to SOC_USB_OTG_SUPPORTED for the reason of
   another USB related peripheral: USB_JTAG_SERIAL
2. correct related document
 2021-07-22 10:43:10 +08:00
Cao Sen Miao
69ad24c943 temp_sensor: add docs for esp32c3 2021-07-21 13:34:52 +08:00
Lv Xin Yue
faee145a61 docs:add esp32-s3-devkitc-1 user guide 2021-07-02 15:21:07 +08:00
Marius Vikhammer
bdfda351bd build docs: enable building of S3 docs 
* Added suport for building esp32s3 docs
 * Fixed all related warnings
 * Activated building of S3 docs for build HTML fast CI job
 2021-06-09 09:30:36 +08:00
Marius Vikhammer
0c17973d54 docs: add rf calibration docs for S2 and C3 2021-05-26 10:09:50 +08:00
Jeroen Domburg
2c75f63f89 * ets_delay_us(1) has too much overhead; change logic 
* Fix MR comments
 2021-04-28 16:38:24 +08:00
Krzysztof Budzynski
632b5c40e6 Revert "Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'" 
This reverts merge request !13293
 2021-04-23 13:44:40 +08:00
Krzysztof Budzynski
3e94dce15e Merge branch 'doc/use_sphinx_reredirect_extension' into 'master' 
Doc: Sphinx uses the sphinx-reredirect extension

See merge request espressif/esp-idf!13293
 2021-04-23 05:13:37 +00:00
Darian Leung
2be772af1c Sphinx uses reredirect extension 
This commit removes the custom HTML rediiect extension and uses
the sphinx-reredirect extension instead. The sphinx-reredirect
extension allows for redirection to external links as well as
support for wildcards.
 2021-04-23 00:02:30 +08:00
Roland Dobai
a2cf1a7d38 docs: Update JTAG debugging guides for ESP32-C3 2021-04-13 12:48:50 +02:00
morris
75dfd970b4 dac: added DAC support macro 
Remove DAC support on ESP32-S3
 2021-04-12 12:04:46 +08:00
Marius Vikhammer
0633ee3e18 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-09 11:57:03 +08:00
Marius Vikhammer
440fab3d6e docs: add google analytics tracking 2021-04-06 11:56:11 +08:00
Marius Vikhammer
91439e3818 docs: updated system api-reference chapters for C3 2021-03-15 18:51:12 +08:00
Marius Vikhammer
6334b5e56f docs: update api-reference chapters for C3 
Checked and updated the following chapters:
 * api-reference/network
 * api-reference/protocols
 * api-reference/provisioning
 * api-reference/storage
 * api-reference/peripherals/ds
 * api-reference/peripherals/hmac
 * api-reference/peripherals/secure_element
 2021-03-01 14:58:08 +08:00
Kang Zuoling
78a1cd3643 touch_element: add touch element api-reference doc 2021-02-22 12:16:49 +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
kirill.chalov
f634c59289 Add hypertargets to all TRM references 2021-01-26 05:51:52 +00:00
Marius Vikhammer
da947d736f Docs: Add C3 support to build_docs 2020-12-28 12:25:03 +08:00
Krzysztof
1c184bd0be docs: ESP-IDF v4.2 fully supports ESP32-S2, remove documentation that describe preview support 2020-12-03 16:21:16 +08:00
morris
91cf7cc58d doc: dedicated gpio api reference 2020-10-20 21:06:10 +08:00
martin.gano
7a9abe3ec5 add chart of version support to version.rst 2020-09-09 11:32:44 +02:00
Andrei Gramakov
c863b4c777 docs: tinyusb documentation 2020-08-27 13:49:33 +02:00
kirill.chalov
954d55bad0 Docs: Add copybutton package to conf_common.py 2020-08-27 02:48:43 +00:00
morris
b30bd7a2ef esp32s2: add CP_DMA driver 2020-08-04 15:28:32 +08:00
Angus Gratton
a2dc60b254 Merge branch 'feature/secure_boot_esp32s2' into 'master' 
Feature/secure boot esp32s2

See merge request espressif/esp-idf!8254
 2020-07-28 16:39:34 +08:00
Supreet Deshpande
33979a9361 Docs: Secure boot v2 support for ESP32-S2 2020-07-27 00:01:10 +00:00
Ivan Grokhotkov
962ea8b9f2 docs: repurpose WROVER-KIT debugging guide for Kaluga-1 2020-07-24 15:54:47 +02:00
Felipe Neves
b6dba84323 ulp: added support to building code for riscv ULP coprocessor 2020-07-15 15:28:49 -03:00
Michael (XIAO Xufeng)
f6dd63d03d spi_slave_hd: new driver for spi slave in half duplex mode 2020-07-11 00:00:50 +08:00
Ivan Grokhotkov
5985c07ab7 docs: add section about USB CDC console 2020-06-26 15:38:49 +02: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
Jakob Hasse
516680a4ff Doc: DS documentation for S2 2020-06-04 10:49:22 +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
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
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
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
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
morris
d003f96a9d gh_action: fix python lint 2020-05-20 10:50:10 +08: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
214f1fbbed docs: add 'edit-on-github' link to html theme 
Closes IDF-1504
 2020-05-06 17:25:23 +08:00
Roland Dobai
ab9f714248 Add build system support for programming ESP32-S2 using DFU utils 2020-04-30 07:59:18 +02:00
Jakob Hasse
2da7e65646 Doc: S2 HMAC documentation 2020-04-27 12:25:46 +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
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
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
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
Supreet Deshpande
073ba0a608 feat/secure_boot_v2: Adding docs for secure boot v2 ESP32-ECO3 2020-02-25 01:28:22 +05:30
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
291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +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
740d422134 docs: Possible fix for blockdiag & seqdiag UnicodeEncodeErrors 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
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
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
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
b0748b4364 docs: Mark some more docs sections as ESP32 only 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
Angus Gratton
783856d557 docs: Move Doxygen build to a Sphinx extension, load sdkconfig & soc caps headers 2020-02-07 16:37:12 +11:00
Angus Gratton
fcf76320c8 docs: Start refactoring IDF-specific docs features into extensions 
Run the actual IDF build system to determine what components are linked
for a particular target.
 2020-02-07 16:37:12 +11:00
Roland Dobai
5454c268f7 Docs: Omit kconfig configurations not available for the target 2020-01-30 10:30:06 +01:00
Ivan Grokhotkov
1cd6f67679 docs: add API guide page about IDF Tools 2020-01-24 14:02:21 +01:00
morris
e30cd361a8 global: rename esp32s2beta to esp32s2 2020-01-22 12:14:38 +08:00
Roland Dobai
84d5cc1c17 Generate source files for kconfiglib from the build system 2019-11-15 15:25:09 +00: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
Angus Gratton
438d513a95 Merge branch 'master' into feature/esp32s2beta_merge 2019-09-16 16:18:48 +10:00
Angus Gratton
49698e15f3 docs: Don't build any docs for the esp32s2beta component 
Re-enable failing CI for warnings in the docs build

This config hack can be removed once IDF-523 is implemented.
 2019-09-13 14:08:21 +10:00
Kirill Chalov
7c491d2335 Allow the extension for adding todo notes to rst files. Add information on how to use this extension to the contribution section. 2019-09-11 17:15:00 +08:00
Roland Dobai
bd21960955 tools: Support sdkconfig.rename files from outside IDF in confgen.py 2019-07-16 20:18:19 +02:00
Angus Gratton
86dbe9299a docs: Load page redirects from a file instead of inline in config 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
754a454402 Introduce separate fonts used by blockdiag, sequdiag, actdiag, nwdiag, rackdiag and packetdiag for Chinese and English version of documentation 2019-05-06 13:19:58 +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
Renz Christian Bagaporo
1177427aac docs: remove invalid arg in confgen invocation on docs generation 2019-01-16 08:16:09 +08:00
Renz Christian Bagaporo
7254476acb docs: list kconfig components alphabetically via component name 2018-12-20 19:57:46 +08:00
Angus Gratton
b240a181b7 docs: Add option to redirect documentation pages which have moved 2018-12-18 14:07:43 +11:00
Roland Dobai
b56ed1a99e docs: Correct Python coding style 2018-12-05 08:22:33 +01:00
Angus Gratton
c0298a5712 Merge branch 'bugfix/doc_builds_windows' into 'master' 
doc: Fix doc builds on Windows MINGW32, add some doc build documentation

See merge request idf/esp-idf!3550
 2018-11-20 17:20:40 +08:00
Angus Gratton
b47aca1175 doc: Fix doc builds on Windows MINGW32, add some doc build documentation 
Using "find" doesn't work properly in MINGW32 Python, even if a MINGW32 find.exe
is on the PATH...
 2018-10-26 04:04:56 +00:00
Roland Dobai
9daf51e6be Fix Python 3 compatibility issues 2018-10-24 11:20:54 +02:00
Anurag Kar
2d199dc521 Docs : Added Provisioning and Protocomm related docs 
Co-Authored-By: Amey Inamdar <amey@espressif.com>
Co-Authored-By: Anurag Kar <anurag.kar@espressif.com>
 2018-10-02 19:07:28 +05:30
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
Angus Gratton
688807d5f6 docs: Don't show Kconfig.projbuild from MQTT submodule examples in docs 2018-09-21 11:05:16 +10:00
Ivan Grokhotkov
91fa1764e5 docs: generate toolchain download links 2018-09-20 18:53:14 +08:00