Commit Graph

11853 Commits

Author SHA1 Message Date
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
ee03e04947 docs: Run build_docs script in ci 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
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
Ivan Grokhotkov
9d333424a1 Merge branch 'bugfix/smtp_strict_prototypes_fix' into 'master'
Fixes for CI regresions

See merge request espressif/esp-idf!7511
2020-02-07 00:43:14 +08:00
Ivan Grokhotkov
d1b7d51dec Merge branch 'bugfix/doc_nwdiag' into 'master'
docs: Fix nwdiag dependency for documentation build

See merge request espressif/esp-idf!7512
2020-02-07 00:42:52 +08:00
Ivan Grokhotkov
8a6c3c254c examples/smtp: fix strict prototypes error in SMTP example 2020-02-06 16:40:13 +01:00
Ivan Grokhotkov
cbf8b60466 ci: re-add the lost PEDANTIC_{C,CXX}FLAGS in CMake example builds 2020-02-06 16:15:58 +01:00
Roland Dobai
8102996b0c docs: Fix nwdiag dependency for documentation build 2020-02-06 12:36:47 +01:00
Angus Gratton
c9cc694dbb Merge branch 'fix/ci_target_test' into 'master'
CI - Fix target variable default value

See merge request espressif/esp-idf!7424
2020-02-06 14:52:10 +08:00
Angus Gratton
fec005ec15 Merge branch 'bugfix/nvs_missing_get' into 'master'
NVS: Fixed missing implementations for string/blob

See merge request espressif/esp-idf!7492
2020-02-06 14:31:16 +08:00
Angus Gratton
5c05af2641 Merge branch 'example/simple_smtp_client' into 'master'
Added simple SMTP email client.

Closes IDF-1292

See merge request espressif/esp-idf!7309
2020-02-06 14:29:43 +08:00
Angus Gratton
fda4efa300 Merge branch 'bugfix/rtc_wdt_timeout' into 'master'
soc/esp32s2: Fix setting timeout for RTC_WDT. ESP32-S2 uses 90KHz instead of 150kHz

See merge request espressif/esp-idf!7499
2020-02-06 14:27:35 +08:00
Angus Gratton
bd9cb9a307 Merge branch 'bugfix/spiffs_case_when_use_mtime_is_not_set' into 'master'
spiffs: Fix for case when CONFIG_SPIFFS_USE_MTIME is not defined

See merge request espressif/esp-idf!7496
2020-02-06 14:26:42 +08:00
Angus Gratton
34b1ea9b3d Merge branch 'feature/netif_ppp_authtype_none' into 'master'
esp-netif: PPPoS fixes

Closes IDFGH-2553 and IDFGH-2548

See merge request espressif/esp-idf!7488
2020-02-06 14:14:43 +08:00
Angus Gratton
98618333a1 Merge branch 'bugfix/wps_config_init' into 'master'
WPS_CONFIG_INIT_DEFAULT(type) error

See merge request espressif/esp-idf!7311
2020-02-06 14:04:31 +08:00