diff --git a/esp_modem/.buildinfo b/esp_modem/.buildinfo index 32db64efd..086b1f188 100644 --- a/esp_modem/.buildinfo +++ b/esp_modem/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 7043fdc66f50c6bac29bc87fc7416928 +config: d740c71820b26864ed688d5e0db8a303 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/esp_modem/.doctrees/README.doctree b/esp_modem/.doctrees/README.doctree index a3feda025..0f88806ee 100644 Binary files a/esp_modem/.doctrees/README.doctree and b/esp_modem/.doctrees/README.doctree differ diff --git a/esp_modem/.doctrees/advanced_api.doctree b/esp_modem/.doctrees/advanced_api.doctree index 9191f0c55..5ce332cb7 100644 Binary files a/esp_modem/.doctrees/advanced_api.doctree and b/esp_modem/.doctrees/advanced_api.doctree differ diff --git a/esp_modem/.doctrees/api_docs.doctree b/esp_modem/.doctrees/api_docs.doctree index 6b9a71f50..5001c189b 100644 Binary files a/esp_modem/.doctrees/api_docs.doctree and b/esp_modem/.doctrees/api_docs.doctree differ diff --git a/esp_modem/.doctrees/cxx_api_docs.doctree b/esp_modem/.doctrees/cxx_api_docs.doctree index 7dd72c22e..1a6748e64 100644 Binary files a/esp_modem/.doctrees/cxx_api_docs.doctree and b/esp_modem/.doctrees/cxx_api_docs.doctree differ diff --git a/esp_modem/.doctrees/cxx_api_links.doctree b/esp_modem/.doctrees/cxx_api_links.doctree index 6797cf93c..1eeb98fb4 100644 Binary files a/esp_modem/.doctrees/cxx_api_links.doctree and b/esp_modem/.doctrees/cxx_api_links.doctree differ diff --git a/esp_modem/.doctrees/environment.pickle b/esp_modem/.doctrees/environment.pickle index 77a4ec38a..693936417 100644 Binary files a/esp_modem/.doctrees/environment.pickle and b/esp_modem/.doctrees/environment.pickle differ diff --git a/esp_modem/.doctrees/index.doctree b/esp_modem/.doctrees/index.doctree index accb22f1e..0537e1271 100644 Binary files a/esp_modem/.doctrees/index.doctree and b/esp_modem/.doctrees/index.doctree differ diff --git a/esp_modem/.doctrees/internal_design.doctree b/esp_modem/.doctrees/internal_design.doctree index cc0ec5d49..23e17151b 100644 Binary files a/esp_modem/.doctrees/internal_design.doctree and b/esp_modem/.doctrees/internal_design.doctree differ diff --git a/esp_modem/.doctrees/internal_docs.doctree b/esp_modem/.doctrees/internal_docs.doctree index 68e67dd22..7b504d203 100644 Binary files a/esp_modem/.doctrees/internal_docs.doctree and b/esp_modem/.doctrees/internal_docs.doctree differ diff --git a/esp_modem/README.html b/esp_modem/README.html index 94f6b5ca7..b08ec27dc 100644 --- a/esp_modem/README.html +++ b/esp_modem/README.html @@ -200,7 +200,7 @@ as a class derived from Sphinx 4.4.0 + Powered by Sphinx 4.5.0 & Alabaster 0.7.12 | diff --git a/esp_modem/_static/doctools.js b/esp_modem/_static/doctools.js index e509e4834..e1bfd708b 100644 --- a/esp_modem/_static/doctools.js +++ b/esp_modem/_static/doctools.js @@ -154,9 +154,7 @@ var Documentation = { this.fixFirefoxAnchorBug(); this.highlightSearchWords(); this.initIndexTable(); - if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { - this.initOnKeyListeners(); - } + this.initOnKeyListeners(); }, /** @@ -269,6 +267,13 @@ var Documentation = { window.history.replaceState({}, '', url); }, + /** + * helper function to focus on search bar + */ + focusSearchBar : function() { + $('input[name=q]').first().focus(); + }, + /** * make the url absolute */ @@ -291,27 +296,54 @@ var Documentation = { }, initOnKeyListeners: function() { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) + return; + $(document).keydown(function(event) { var activeElementType = document.activeElement.tagName; // don't navigate when in search box, textarea, dropdown or button if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' - && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey - && !event.shiftKey) { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; - } - break; - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - break; + && activeElementType !== 'BUTTON') { + if (event.altKey || event.ctrlKey || event.metaKey) + return; + + if (!event.shiftKey) { + switch (event.key) { + case 'ArrowLeft': + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) + break; + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + break; + case 'ArrowRight': + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) + break; + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + break; + case 'Escape': + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) + break; + Documentation.hideSearchWords(); + return false; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case '/': + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) + break; + Documentation.focusSearchBar(); + return false; } } }); diff --git a/esp_modem/_static/documentation_options.js b/esp_modem/_static/documentation_options.js index 4daa6b50b..b57ae3b83 100644 --- a/esp_modem/_static/documentation_options.js +++ b/esp_modem/_static/documentation_options.js @@ -8,5 +8,7 @@ var DOCUMENTATION_OPTIONS = { LINK_SUFFIX: '.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, }; \ No newline at end of file diff --git a/esp_modem/_static/searchtools.js b/esp_modem/_static/searchtools.js index 2d7785937..0a44e8582 100644 --- a/esp_modem/_static/searchtools.js +++ b/esp_modem/_static/searchtools.js @@ -172,10 +172,6 @@ var Search = { } // stem the word var word = stemmer.stemWord(tmp[i].toLowerCase()); - // prevent stemmer from cutting word smaller than two chars - if(word.length < 3 && tmp[i].length >= 3) { - word = tmp[i]; - } var toAppend; // select the correct list if (word[0] == '-') { @@ -276,7 +272,7 @@ var Search = { setTimeout(function() { displayNextItem(); }, 5); - } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { + } else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) { $.ajax({url: requestUrl, dataType: "text", complete: function(jqxhr, textstatus) { @@ -293,7 +289,7 @@ var Search = { }, 5); }}); } else { - // no source available, just display title + // just display title Search.output.append(listItem); setTimeout(function() { displayNextItem(); diff --git a/esp_modem/advanced_api.html b/esp_modem/advanced_api.html index aff1fefb7..05d56d833 100644 --- a/esp_modem/advanced_api.html +++ b/esp_modem/advanced_api.html @@ -275,7 +275,7 @@ a custom DTE object and supply it into Sphinx 4.4.0 + Powered by Sphinx 4.5.0 & Alabaster 0.7.12 | diff --git a/esp_modem/api_docs.html b/esp_modem/api_docs.html index 4571dcbde..eb26f78b6 100644 --- a/esp_modem/api_docs.html +++ b/esp_modem/api_docs.html @@ -727,7 +727,7 @@ pointer as the return value. The API expects the output data to point to user al
-int task_priority
+unsigned task_priority

Terminal task priority

@@ -743,6 +743,12 @@ pointer as the return value. The API expects the output data to point to user al

Configuration for VFS Terminal

+
+
+void *extension_config
+

Configuration for app specific Terminal

+
+ @@ -834,7 +840,7 @@ pointer as the return value. The API expects the output data to point to user al ©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd. | - Powered by Sphinx 4.4.0 + Powered by Sphinx 4.5.0 & Alabaster 0.7.12 | diff --git a/esp_modem/cxx_api_docs.html b/esp_modem/cxx_api_docs.html index 43da04f30..c4bc4d2ad 100644 --- a/esp_modem/cxx_api_docs.html +++ b/esp_modem/cxx_api_docs.html @@ -263,7 +263,7 @@ It simply gets destroyed and cleaned-up automatically if the object goes out of ©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd. | - Powered by Sphinx 4.4.0 + Powered by Sphinx 4.5.0 & Alabaster 0.7.12 | diff --git a/esp_modem/cxx_api_links.html b/esp_modem/cxx_api_links.html index 16fb84d28..755ace3bf 100644 --- a/esp_modem/cxx_api_links.html +++ b/esp_modem/cxx_api_links.html @@ -117,7 +117,7 @@ ©2016 - 2021, Espressif Systems (Shanghai) Co., Ltd. | - Powered by Sphinx 4.4.0 + Powered by Sphinx 4.5.0 & Alabaster 0.7.12 | diff --git a/esp_modem/genindex.html b/esp_modem/genindex.html index f4fbcf4b4..a519d1887 100644 --- a/esp_modem/genindex.html +++ b/esp_modem/genindex.html @@ -239,10 +239,10 @@
  • esp_modem_dce_config::apn (C++ member)
    • - - +