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