From ce40b34e16c039e6aa9856a7d4b4cdfe40f46dd3 Mon Sep 17 00:00:00 2001 From: felixfontein Date: Mon, 21 Aug 2023 20:13:03 +0000 Subject: [PATCH] deploy: adff9bbf8c58563b92be20f0e462acc098cad8bb --- branch/main/_static/basic.css | 22 ++++++++++++++ branch/main/_static/documentation_options.js | 3 +- branch/main/_static/searchtools.js | 26 ++++++++++------ branch/main/_static/sphinx_highlight.js | 16 ++++++++-- branch/main/api_facts_module.html | 30 +++++++++--------- branch/main/api_find_and_modify_module.html | 32 ++++++++++---------- branch/main/api_info_module.html | 31 ++++++++++--------- branch/main/api_modify_module.html | 31 ++++++++++--------- branch/main/api_module.html | 32 ++++++++++---------- branch/main/command_module.html | 30 +++++++++--------- branch/main/docsite/api-guide.html | 20 ++++++------ branch/main/docsite/quoting.html | 12 ++++---- branch/main/docsite/ssh-guide.html | 18 +++++------ branch/main/environment_variables.html | 12 ++++---- branch/main/facts_module.html | 28 ++++++++--------- branch/main/index.html | 26 ++++++++-------- branch/main/join_filter.html | 24 +++++++-------- branch/main/list_to_dict_filter.html | 26 ++++++++-------- branch/main/quote_argument_filter.html | 24 +++++++-------- branch/main/quote_argument_value_filter.html | 24 +++++++-------- branch/main/routeros_cliconf.html | 18 +++++------ branch/main/search.html | 10 +++--- branch/main/searchindex.js | 2 +- branch/main/split_filter.html | 24 +++++++-------- 24 files changed, 281 insertions(+), 240 deletions(-) diff --git a/branch/main/_static/basic.css b/branch/main/_static/basic.css index 7577acb..30fee9d 100644 --- a/branch/main/_static/basic.css +++ b/branch/main/_static/basic.css @@ -237,6 +237,10 @@ a.headerlink { visibility: hidden; } +a:visited { + color: #551A8B; +} + h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, @@ -670,6 +674,16 @@ dd { margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + dl > dd:last-child, dl > dd:last-child > :last-child { margin-bottom: 0; @@ -738,6 +752,14 @@ abbr, acronym { cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { diff --git a/branch/main/_static/documentation_options.js b/branch/main/_static/documentation_options.js index bcae2ea..1823c1b 100644 --- a/branch/main/_static/documentation_options.js +++ b/branch/main/_static/documentation_options.js @@ -1,5 +1,4 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), +const DOCUMENTATION_OPTIONS = { VERSION: '', LANGUAGE: 'en', COLLAPSE_INDEX: false, diff --git a/branch/main/_static/searchtools.js b/branch/main/_static/searchtools.js index 97d56a7..7918c3f 100644 --- a/branch/main/_static/searchtools.js +++ b/branch/main/_static/searchtools.js @@ -57,12 +57,12 @@ const _removeChildren = (element) => { const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string -const _displayItem = (item, searchTerms) => { +const _displayItem = (item, searchTerms, highlightTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; const [docName, title, anchor, descr, score, _filename] = item; @@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => { if (dirname.match(/\/index\/$/)) dirname = dirname.substring(0, dirname.length - 6); else if (dirname === "index/") dirname = ""; - requestUrl = docUrlRoot + dirname; + requestUrl = contentRoot + dirname; linkUrl = requestUrl; } else { // normal html builders - requestUrl = docUrlRoot + docName + docFileSuffix; + requestUrl = contentRoot + docName + docFileSuffix; linkUrl = docName + docLinkSuffix; } let linkEl = listItem.appendChild(document.createElement("a")); linkEl.href = linkUrl + anchor; linkEl.dataset.score = score; linkEl.innerHTML = title; - if (descr) + if (descr) { listItem.appendChild(document.createElement("span")).innerHTML = " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } else if (showSearchSummary) fetch(requestUrl) .then((responseData) => responseData.text()) @@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => { listItem.appendChild( Search.makeSearchSummary(data, searchTerms) ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); }); Search.output.appendChild(listItem); }; @@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => { const _displayNextItem = ( results, resultCount, - searchTerms + searchTerms, + highlightTerms, ) => { // results left, load the summary and display it // this is intended to be dynamic (don't sub resultsCount) if (results.length) { - _displayItem(results.pop(), searchTerms); + _displayItem(results.pop(), searchTerms, highlightTerms); setTimeout( - () => _displayNextItem(results, resultCount, searchTerms), + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), 5 ); } @@ -360,7 +368,7 @@ const Search = { // console.info("search results:", Search.lastresults); // print the results - _displayNextItem(results, results.length, searchTerms); + _displayNextItem(results, results.length, searchTerms, highlightTerms); }, /** diff --git a/branch/main/_static/sphinx_highlight.js b/branch/main/_static/sphinx_highlight.js index aae669d..8a96c69 100644 --- a/branch/main/_static/sphinx_highlight.js +++ b/branch/main/_static/sphinx_highlight.js @@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => { } span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); parent.insertBefore( span, parent.insertBefore( - document.createTextNode(val.substr(pos + text.length)), + rest, node.nextSibling ) ); node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); if (isInSVG) { const rect = document.createElementNS( @@ -140,5 +145,10 @@ const SphinxHighlight = { }, }; -_ready(SphinxHighlight.highlightSearchWords); -_ready(SphinxHighlight.initEscapeListener); +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/branch/main/api_facts_module.html b/branch/main/api_facts_module.html index 224acfe..6259eb6 100644 --- a/branch/main/api_facts_module.html +++ b/branch/main/api_facts_module.html @@ -14,11 +14,11 @@ - - - - - + + + + + @@ -141,7 +141,7 @@
-

community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API

+

community.routeros.api_facts module – Collect facts from remote devices running MikroTik RouterOS using the API

Note

This module is part of the community.routeros collection (version 2.9.0).

@@ -163,14 +163,14 @@ see -

Synopsis

+

Synopsis

  • Collects a base set of device facts from a remote device that is running RouterOS. This module prepends all of the base network fact keys with ansible_net_<fact>. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

  • As opposed to the community.routeros.facts module, it uses the RouterOS API, similar to the community.routeros.api module.

-

Requirements

+

Requirements

The below requirements are needed on the host that executes this module.

-

Attributes

+

Attributes

@@ -259,7 +259,7 @@

Attribute

-

Notes

+

Notes

Note

    @@ -268,7 +268,7 @@
-

See Also

+

See Also

See also

@@ -280,7 +280,7 @@
-

Examples

+

Examples

- name: Run command on remote devices
   community.routeros.command:
     commands: /system routerboard print
@@ -308,7 +308,7 @@
-

Return Values

+

Return Values

Common return values are documented here, the following are the fields unique to this module:

@@ -347,13 +347,13 @@
-

Authors

+

Authors

  • Egor Zaitsev (@heuels)