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/acme_account_facts_module.html b/branch/main/acme_account_facts_module.html index 9ec96226..4cae2b9f 100644 --- a/branch/main/acme_account_facts_module.html +++ b/branch/main/acme_account_facts_module.html @@ -14,11 +14,11 @@ - - - - - + + + + + @@ -150,7 +150,7 @@
-

community.crypto.acme_account_facts

+

community.crypto.acme_account_facts

Note

This plugin was part of the community.crypto collection (version 2.16.0).

diff --git a/branch/main/acme_account_info_module.html b/branch/main/acme_account_info_module.html index 3426a02e..b112f789 100644 --- a/branch/main/acme_account_info_module.html +++ b/branch/main/acme_account_info_module.html @@ -14,11 +14,11 @@ - - - - - + + + + + @@ -168,7 +168,7 @@
-

community.crypto.acme_account_info module – Retrieves information on ACME accounts

+

community.crypto.acme_account_info module – Retrieves information on ACME accounts

Note

This module is part of the community.crypto collection (version 2.16.0).

@@ -190,14 +190,14 @@ see -

Synopsis

+

Synopsis

  • Allows to retrieve information on accounts a CA supporting the ACME protocol, such as Let’s Encrypt.

  • This module only works with the ACME v2 protocol.

-

Requirements

+

Requirements

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

  • either openssl or cryptography >= 1.5

    • @@ -205,7 +205,7 @@ see -

    Parameters

    +

    Parameters

    @@ -339,7 +339,7 @@ see -

    Attributes

    +

    Attributes

    Parameter
    @@ -378,7 +378,7 @@ see -

    Notes

    +

    Notes

    Note

    Attribute
    @@ -647,13 +647,13 @@ see -

    Authors

    +

    Authors

    • Felix Fontein (@felixfontein)

    @@ -442,7 +442,7 @@ see -

    Attributes

    +

    Attributes

    Parameter
    @@ -479,7 +479,7 @@ see -

    Notes

    +

    Notes

    Note

    Attribute
    @@ -561,13 +561,13 @@ see -

    Authors

    +

    Authors

    • Felix Fontein (@felixfontein)

    @@ -560,7 +560,7 @@ see -

    Attributes

    +

    Attributes

    Parameter
    @@ -605,7 +605,7 @@ see -

    Notes

    +

    Notes

    Note

    Attribute
    @@ -939,13 +939,13 @@ see -

    Authors

    +

    Authors

    • Michael Gruener (@mgruener)

    @@ -361,7 +361,7 @@ see -

    Attributes

    +

    Attributes

    Parameter
    @@ -398,7 +398,7 @@ see -

    Notes

    +

    Notes

    Note

      @@ -411,7 +411,7 @@ see -

      See Also

      +

      See Also

      See also

      @@ -425,7 +425,7 @@ see -

      Examples

      +

      Examples

      - name: Revoke certificate with account key
   community.crypto.acme_certificate_revoke:
     account_key_src: /etc/pki/cert/private/account.key
@@ -438,13 +438,13 @@ see 
-
      Authors
      
+
      Authors
      
 
        
 
      • Felix Fontein (@felixfontein)
        •

    Attribute
    @@ -256,7 +256,7 @@ see -

    Attributes

    +

    Attributes

    Parameter
    @@ -287,7 +287,7 @@ see -

    See Also

    +

    See Also

    See also

    @@ -299,7 +299,7 @@ see -

    Examples

    +

    Examples

    - name: Create challenges for a given CRT for sample.com
   community.crypto.acme_certificate:
     account_key_src: /etc/pki/cert/private/account.key
@@ -343,7 +343,7 @@ see 
-
    Return Values
    
+
    Return Values
    
 
    Common return values are documented here, the following are the fields unique to this module:

    Attribute
    @@ -401,13 +401,13 @@ see -

    Authors

    +

    Authors

    • Felix Fontein (@felixfontein)

    @@ -368,7 +368,7 @@ see -

    Attributes

    +

    Attributes

    Parameter
    @@ -405,7 +405,7 @@ see -

    Notes

    +

    Notes

    Note

    Attribute
    @@ -580,13 +580,13 @@ see -

    Authors

    +

    Authors

    • Felix Fontein (@felixfontein)

    @@ -242,7 +242,7 @@ see -

    Attributes

    +

    Attributes

    Parameter
    @@ -273,7 +273,7 @@ see -

    Examples

    +

    Examples

    # Given a leaf certificate for www.ansible.com and one or more intermediate
 # certificates, finds the associated root certificate.
 - name: Find root certificate
@@ -309,7 +309,7 @@ see 
-
    Return Values
    
+
    Return Values
    
 
    Common return values are documented here, the following are the fields unique to this module:

    Attribute
    @@ -347,13 +347,13 @@ see -

    Authors

    +

    Authors

    • Felix Fontein (@felixfontein)

    @@ -219,7 +219,7 @@

    Attribute

-

Examples

+

Examples

- name: Retrieve information
   community.crypto.crypto_info:
     account_key_src: /etc/pki/cert/private/account.key
@@ -232,7 +232,7 @@
-

Return Values

+

Return Values

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

@@ -447,13 +447,13 @@
-

Authors

+

Authors

  • Felix Fontein (@felixfontein)