Commit graph

1629 commits

Author SHA1 Message Date
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
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 8102996b0c docs: Fix nwdiag dependency for documentation build 2020-02-06 12:36:47 +01:00
Konstantin Kondrashov 739eb05bb9 esp32: add implementation of esp_timer based on TG0 LAC timer
Closes: IDF-979
2020-02-06 14:00:18 +08:00
Angus Gratton 9ebb48ff9d Merge branch 'bugfix/idf_fullclean_loses_target' into 'master'
idf.py: guess IDF_TARGET from sdkconfig/sdkconfig.defaults, error out if IDF_TARGET is inconsistent

Closes IDF-869 and IDF-1040

See merge request espressif/esp-idf!7486
2020-02-05 07:41:11 +08:00
Ivan Grokhotkov 036a29bb3d docs: update build system guide on setting IDF_TARGET 2020-01-31 10:19:44 +01:00
Roland Dobai 5454c268f7 Docs: Omit kconfig configurations not available for the target 2020-01-30 10:30:06 +01:00
Felipe Neves 5cbb3f05c0 freertos: Added experimental, optional FPU usage on level 1 ISR 2020-01-27 10:55:03 -03:00
Ivan Grokhotkov 1cd6f67679 docs: add API guide page about IDF Tools 2020-01-24 14:02:21 +01:00
Angus Gratton c1ab87b580 Merge branch 'bugfix/fix_broken_example_link' into 'master'
doc:fix icmp initialization and broken example links

Closes IDFGH-2563

See merge request espressif/esp-idf!7402
2020-01-23 14:32:55 +08:00
morris e30cd361a8 global: rename esp32s2beta to esp32s2 2020-01-22 12:14:38 +08:00
Felipe Neves 73592d9bc4 spin_lock: added new spinlock interface and decoupled it from RTOS
spin_lock: cleaned-up port files and removed portmux files

components/soc: decoupled compare and set operations from FreeRTOS

soc/spinlock: filled initial implementation of spinlock refactor

It will decouple the spinlocks into separated components with not depencences of freertos
an similar interface was provided focusing the readabillity and maintenance, also
naming to spinlocks were adopted. On FreeRTOS side the legacy portMUX macros
gained a form of wrapper functions that calls the spinlocks component thus
minimizing the impact on RTOS side.

This feature aims to close IDF-967

soc/spinlock: spinlocks passed on unit test, missing test corner cases

components/compare_set: added better function namings plus minor performance optimization on spinlocks

soc/spinlock: code reordering to remove ISC C90 mix error

freertos/portmacro: gor rid of critical sections multiline macros, placed inline functions instead

soc/spinlock: improved spinlock performance from internal RAM

For cases where the spinlock is executed from IRAM, there is no
need to check where the spinlock object is placed on memory,
removing this checks caused a great improvement on performance.
2020-01-22 06:20:34 +08:00
morris f2cb6bd4b6 doc: fix broken example links 2020-01-21 12:11:24 +08:00
morris 1c710a1b31 doc: fix incomplete ping session initialization
Thanks @nopnop2002 for reporting this issue.
Closes https://github.com/espressif/esp-idf/issues/4648
2020-01-21 12:07:38 +08:00
Krzysztof Budzynski ac27ab29fd doc: Fix broken links to examples 2020-01-20 12:10:18 +08:00
Angus Gratton eaafe7f599 Merge branch 'feature/add_setting_project_version_from_kconfig' into 'master'
build: Add CONFIG_APP_PROJECT_VER to set the project version from Kconfig

See merge request espressif/esp-idf!7125
2020-01-16 15:54:14 +08:00
Wang Ning 0093f50214 Add Chinese translation to LEDC.
Need technical and language review.
2020-01-16 10:13:40 +08:00