From 0608976be8482b05bb39efa0b6162389e7304245 Mon Sep 17 00:00:00 2001 From: felixfontein Date: Tue, 22 Aug 2023 09:24:26 +0000 Subject: [PATCH] deploy: 6f6dd14492bce445bdc325f734497e52629c32a9 --- 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 ++++-- .../main/current_container_facts_module.html | 24 ++++----- branch/main/docker_api_connection.html | 24 ++++----- branch/main/docker_compose_module.html | 30 +++++------ branch/main/docker_config_module.html | 30 +++++------ branch/main/docker_connection.html | 20 +++---- .../docker_container_copy_into_module.html | 30 +++++------ branch/main/docker_container_exec_module.html | 30 +++++------ branch/main/docker_container_info_module.html | 30 +++++------ branch/main/docker_container_module.html | 30 +++++------ branch/main/docker_containers_inventory.html | 26 ++++----- branch/main/docker_host_info_module.html | 30 +++++------ branch/main/docker_image_info_module.html | 30 +++++------ branch/main/docker_image_load_module.html | 30 +++++------ branch/main/docker_image_module.html | 30 +++++------ branch/main/docker_login_module.html | 30 +++++------ branch/main/docker_machine_inventory.html | 24 ++++----- branch/main/docker_network_info_module.html | 30 +++++------ branch/main/docker_network_module.html | 30 +++++------ branch/main/docker_node_info_module.html | 30 +++++------ branch/main/docker_node_module.html | 30 +++++------ branch/main/docker_plugin_module.html | 30 +++++------ branch/main/docker_prune_module.html | 30 +++++------ branch/main/docker_secret_module.html | 30 +++++------ branch/main/docker_stack_info_module.html | 24 ++++----- branch/main/docker_stack_module.html | 28 +++++----- .../main/docker_stack_task_info_module.html | 26 ++++----- branch/main/docker_swarm_info_module.html | 30 +++++------ branch/main/docker_swarm_inventory.html | 24 ++++----- branch/main/docker_swarm_module.html | 30 +++++------ .../docker_swarm_service_info_module.html | 30 +++++------ branch/main/docker_swarm_service_module.html | 30 +++++------ branch/main/docker_volume_info_module.html | 30 +++++------ branch/main/docker_volume_module.html | 30 +++++------ branch/main/docsite/scenario_guide.html | 54 +++++++++---------- branch/main/environment_variables.html | 18 +++---- branch/main/index.html | 26 ++++----- branch/main/nsenter_connection.html | 22 ++++---- branch/main/search.html | 10 ++-- branch/main/searchindex.js | 2 +- 43 files changed, 589 insertions(+), 550 deletions(-) diff --git a/branch/main/_static/basic.css b/branch/main/_static/basic.css index 7577acb1..30fee9d0 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 bcae2ea9..1823c1bd 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 97d56a74..7918c3fa 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 aae669d7..8a96c69a 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/current_container_facts_module.html b/branch/main/current_container_facts_module.html index b9467fde..6181ba72 100644 --- a/branch/main/current_container_facts_module.html +++ b/branch/main/current_container_facts_module.html @@ -14,11 +14,11 @@ - - - - - + + + + + @@ -157,7 +157,7 @@
-

community.docker.current_container_facts module – Return facts about whether the module runs in a container

+

community.docker.current_container_facts module – Return facts about whether the module runs in a container

Note

This module is part of the community.docker collection (version 3.5.0).

@@ -174,14 +174,14 @@
-

Synopsis

+

Synopsis

  • Return facts about whether the module runs in a Docker or podman container.

  • This module attempts a best-effort detection. There might be special cases where it does not work; if you encounter one, please file an issue.

-

Attributes

+

Attributes

@@ -220,7 +220,7 @@

Attribute

-

Examples

+

Examples

- name: Get facts on current container
   community.docker.current_container_facts:
 
@@ -232,7 +232,7 @@
 
-

Returned Facts

+

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

@@ -282,13 +282,13 @@
-

Authors

+

Authors

  • Felix Fontein (@felixfontein)