docs: documentation 3.2

.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: ca70197c82d4adc6ebb4b3eb5c1d193e
+config: 93898538c024605e6f316a0a1364595d
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_static/agogo.css

@@ -19,6 +19,10 @@ body {
   line-height: 1.4em;
   color: black;
   background-color: #eeeeec;
+
+  /* fix for background colors breaking at horizontal
+    scrolling on smaller devices */
+  min-width: fit-content;
 }
 
 
@@ -41,6 +45,10 @@ a {
   color: #ce5c00;
 }
 
+a:visited {
+  color: #551a8b;
+}
+
 div.bodywrapper a, div.footer a {
   text-decoration: underline;
 }
@@ -127,8 +135,7 @@ dt:target, .highlighted {
 /* Header */
 
 div.header {
-  padding-top: 10px;
-  padding-bottom: 10px;
+  padding: 1em;
 }
 
 div.header .headertitle {
@@ -165,8 +172,7 @@ img.logo {
 /* Content */
 div.content-wrapper {
   background-color: white;
-  padding-top: 20px;
-  padding-bottom: 20px;
+  padding: 1em;
 }
 
 div.document {

_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 {

_static/documentation_options.js

@@ -1,6 +1,5 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.1',
+const DOCUMENTATION_OPTIONS = {
+    VERSION: '3.2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

_static/pygments.css

@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #FF0000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */

_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);
   },
 
   /**

_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();
+});

authentication.html

@@ -1,16 +1,16 @@
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="./">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Security &#8212; pyrfc 3.1 documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="_static/agogo.css" />
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
+    <title>Security &#8212; pyrfc 3.2 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="_static/agogo.css?v=87cb3894" />
+    <script src="_static/documentation_options.js?v=828ea960"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Building from source" href="build.html" />
@@ -19,7 +19,7 @@
     <div class="header-wrapper" role="banner">
       <div class="header">
         <div class="headertitle"><a
-          href="index.html">pyrfc 3.1 documentation</a></div>
+          href="index.html">pyrfc 3.2 documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
           <a href="server.html" title="Server scenario"
              accesskey="P">previous</a> |
@@ -40,7 +40,7 @@
           <div class="body" role="main">
 
   <section id="security">
-<span id="authentication"></span><h1>Security<a class="headerlink" href="#security" title="Permalink to this heading">¶</a></h1>
+<span id="authentication"></span><h1>Security<a class="headerlink" href="#security" title="Link to this heading">¶</a></h1>
 <p>Plain RFC connections are mainly used for prototyping, while in production
 secure connections are required. For more information on RFC security see:</p>
 <ul class="simple">
@@ -67,9 +67,9 @@
 configured for SNC communication, here you may find connection strings examples,
 for testing plain and secure RFC connections, with various authentication methods.</p>
 <section id="id1">
-<h2>Authentication<a class="headerlink" href="#id1" title="Permalink to this heading">¶</a></h2>
+<h2>Authentication<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h2>
 <section id="plain-auth">
-<span id="id2"></span><h3>Plain with user / password<a class="headerlink" href="#plain-auth" title="Permalink to this heading">¶</a></h3>
+<span id="id2"></span><h3>Plain with user / password<a class="headerlink" href="#plain-auth" title="Link to this heading">¶</a></h3>
 <p>The simplest and least secure form of the user authentication.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">ABAP_SYSTEM</span> <span class="o">=</span> <span class="p">{</span>
      <span class="s1">&#39;user&#39;</span><span class="p">:</span> <span class="s1">&#39;demo&#39;</span><span class="p">,</span>
@@ -88,7 +88,7 @@ <h2>Authentication<a class="headerlink" href="#id1" title="Permalink to this hea
 </div>
 </section>
 <section id="snc-with-user-pse">
-<span id="id3"></span><h3>SNC with User PSE<a class="headerlink" href="#snc-with-user-pse" title="Permalink to this heading">¶</a></h3>
+<span id="id3"></span><h3>SNC with User PSE<a class="headerlink" href="#snc-with-user-pse" title="Link to this heading">¶</a></h3>
 <p><a class="reference external" href="http://help.sap.com/saphelp_nw73/helpdata/en/4c/61a6c6364012f3e10000000a15822b/content.htm?frameset=/en/4c/6269c8c72271d0e10000000a15822b/frameset.htm">User PSE</a>
 is used for opening the SNC connection and the same user is used for the authentication
 (logon) in NW ABAP backend. Generally not recomended, see <a class="reference external" href="https://launchpad.support.sap.com/#/notes/1028503">SAP Note 1028503 - SNC-secured RFC connection: Logon ticket is ignored</a></p>
@@ -121,7 +121,7 @@ <h2>Authentication<a class="headerlink" href="#id1" title="Permalink to this hea
 not have to be provided as a parameter for opening SNC connection.</p>
 </section>
 <section id="snc-with-x509">
-<span id="snc-with-x50"></span><h3>SNC with X509<a class="headerlink" href="#snc-with-x509" title="Permalink to this heading">¶</a></h3>
+<span id="snc-with-x50"></span><h3>SNC with X509<a class="headerlink" href="#snc-with-x509" title="Link to this heading">¶</a></h3>
 <p>The client system PSE is used for opening SNC connection and forwarding user
 X509 certificate to NW ABAP backend system, for authentication and logon.</p>
 <p><strong>Prerequisites</strong></p>
@@ -225,9 +225,9 @@ <h3 style="margin-top: 1.5em;">Search</h3>
         <div class="right">
 
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014, SAP.
-      Last updated on 2023-07-24 15:30.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
+    &#169; Copyright 2014, SAP.
+      Last updated on 2023-10-02 13:53.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
     </div>
         </div>
         <div class="clearer"></div>

bibliography.html

@@ -1,16 +1,16 @@
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="./">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Bibliography &#8212; pyrfc 3.1 documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="_static/agogo.css" />
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-    <script src="_static/doctools.js"></script>
-    <script src="_static/sphinx_highlight.js"></script>
+    <title>Bibliography &#8212; pyrfc 3.2 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="_static/agogo.css?v=87cb3894" />
+    <script src="_static/documentation_options.js?v=828ea960"></script>
+    <script src="_static/doctools.js?v=888ff710"></script>
+    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="pyrfc" href="pyrfc.html" />
@@ -19,7 +19,7 @@
     <div class="header-wrapper" role="banner">
       <div class="header">
         <div class="headertitle"><a
-          href="index.html">pyrfc 3.1 documentation</a></div>
+          href="index.html">pyrfc 3.2 documentation</a></div>
         <div class="rel" role="navigation" aria-label="related navigation">
           <a href="remarks.html" title="Remarks"
              accesskey="P">previous</a> |
@@ -40,21 +40,21 @@
           <div class="body" role="main">
 
   <section id="bibliography">
-<h1>Bibliography<a class="headerlink" href="#bibliography" title="Permalink to this heading">¶</a></h1>
+<h1>Bibliography<a class="headerlink" href="#bibliography" title="Link to this heading">¶</a></h1>
 <section id="schmidt-and-li-2009a">
-<span id="c09a"></span><h2>Schmidt and Li (2009a)<a class="headerlink" href="#schmidt-and-li-2009a" title="Permalink to this heading">¶</a></h2>
+<span id="c09a"></span><h2>Schmidt and Li (2009a)<a class="headerlink" href="#schmidt-and-li-2009a" title="Link to this heading">¶</a></h2>
 <p>Improve communication between your C/C++ applications and SAP systems with SAP NetWeaver RFC SDK -
 <a class="reference external" href="https://scn.sap.com/docs/DOC-52886">Part 1: RFC Client Programming</a>,
 <em>SAP Professional Journal</em>, pp 1-16 (originally published in November 2007)</p>
 </section>
 <section id="schmidt-and-li-2009b">
-<span id="c09b"></span><h2>Schmidt and Li (2009b)<a class="headerlink" href="#schmidt-and-li-2009b" title="Permalink to this heading">¶</a></h2>
+<span id="c09b"></span><h2>Schmidt and Li (2009b)<a class="headerlink" href="#schmidt-and-li-2009b" title="Link to this heading">¶</a></h2>
 <p>Improve communication between your C/C++ applications and SAP systems with SAP NetWeaver RFC SDK -
 - <a class="reference external" href="https://scn.sap.com/docs/DOC-52887">Part 2: RFC Server Programming</a>,
 <em>SAP Professional Journal</em>, pp 1-13 (originally published in January/February 2008)</p>
 </section>
 <section id="schmidt-and-li-2009c">
-<span id="c09c"></span><h2>Schmidt and Li (2009c)<a class="headerlink" href="#schmidt-and-li-2009c" title="Permalink to this heading">¶</a></h2>
+<span id="c09c"></span><h2>Schmidt and Li (2009c)<a class="headerlink" href="#schmidt-and-li-2009c" title="Link to this heading">¶</a></h2>
 <p>Improve communication between your C/C++ applications and SAP systems with SAP NetWeaver RFC SDK -
 <a class="reference external" href="https://scn.sap.com/docs/DOC-52888">Part 3: Advanced Topics</a>,
 <em>SAP Professional Journal</em>, pp 1-18 (originally published in March 2008)</p>
@@ -123,9 +123,9 @@ <h3 style="margin-top: 1.5em;">Search</h3>
         <div class="right">
 
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2014, SAP.
-      Last updated on 2023-07-24 15:30.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.0.1.
+    &#169; Copyright 2014, SAP.
+      Last updated on 2023-10-02 13:53.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
     </div>
         </div>
         <div class="clearer"></div>