Adam Múdry
556816423c
docs(fatfs): Move mentioned APIs to a separate API reference section
2023-08-14 12:59:08 +02:00
Adam Múdry
8af790da45
fatfs: Add mock option to ff_sdmmc_status function to increase IO speed
...
Adds `disk_status_check_enable` field to `esp_vfs_fat_mount_config_t` struct to control if ff_sdmmc_status is mocked or not.
2022-06-09 20:09:32 +00:00
morris
b870c26837
doc: move mqtt_client.h into known warnings
2022-05-18 16:28:19 +08:00
weitianhua
4c370cc437
component_bt: Fix build doc errors of bt
...
1. bluedroid: use standard function pointer define.
2. blufi: Change ESP_BD_ADDR_LEN into ESP_BLUFI_BD_ADDR_LEN
3. doc/sphinx_known_warnings: Remove fixed parts.
2022-05-11 14:30:20 +00:00
morris
a7f6f8677a
doc: update api reference for new rmt driver
2022-05-07 10:34:50 +00:00
morris
f474735791
doc: add esp_hd_cb_t type definition as known warnings
2022-05-06 18:35:56 +08:00
Marius Vikhammer
197be02748
docs: update esp-docs 1.0.0
...
Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-25 12:07:11 +08:00
Marius Vikhammer
e07be3df49
docs: ignore duplicate def warning in BT docs
2021-06-30 15:10:43 +08:00
KonstantinKondrashov
9295e54c9d
docs: Adds secure_boot_v2 for ESP32-C3 ECO3
2021-04-08 14:22:46 +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
Felipe Neves
b6dba84323
ulp: added support to building code for riscv ULP coprocessor
2020-07-15 15:28:49 -03: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
11fac8637a
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +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
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
13f67d4279
doc: Remove duplicate ulp-cmake
...
This file was renamed in 62ed221
when CMake became default, but 8fe3ecd
accidentally reintroduced it.
A redirect is still generated from ulp-cmake to ulp, so the old URL continues to work.
2020-01-10 16:38:06 +11:00
Dmitry Yakovlev
8fe3ecd000
Added description for difference between ESP32 ULP and ESP32-S2 ULP
...
Jumpr instruction updated.
2019-12-13 18:38:57 +08:00
michael
538540ce21
mcpwm: add HAL layer support
...
Also improved the unit tests a bit.
2019-11-25 00:36:30 +08:00
Angus Gratton
222146845c
docs: Make CMake build system default, mark GNU Make as legacy option
...
All `-cmake` suffixes are removed
Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-07-09 14:32:26 +10:00
Michael (XIAO Xufeng)
37cb673cd7
esp_flash: update the document to the latest API
2019-06-20 11:50:23 +08:00
krzychb
e1e8c36492
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-27 22:11:59 +01:00
krzychb
7cc6b3c5ec
Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041 . Upgraded Breathe to latest release 4.7.3 as well.
2017-10-31 22:57:39 +01:00
Angus Gratton
4b8aa9e20d
ci: Add new check_doc_warnings.sh script, pre-process log lines
...
* Fixes issue in !1250 when IDF_PATH changes on build runner
* Allows checking document warnings before CI run
* Will be robust to line number changes in document files
2017-09-14 13:46:35 +10:00
krzychb
59792bb2c3
Fail CI build on Sphinx warnings
2017-09-12 07:12:57 +02:00