Updating the docs in dev/ for branch: master, commit ca798a7 [skip ci]

pydicom · Oct 8, 2023 · 58fed7b · 58fed7b
1 parent f845db6
commit 58fed7b
Show file tree

Hide file tree

Showing 587 changed files with 6,303 additions and 6,263 deletions.
diff --git a/dev/_sources/apps/movescu.rst.txt b/dev/_sources/apps/movescu.rst.txt
@@ -522,7 +522,7 @@ SOP Classes
 +----------------------------------+------------------------------------------+
 | 1.2.840.10008.5.1.4.1.1.481.10   | RT Physician Intent Storage              |
 +----------------------------------+------------------------------------------+
-| 1.2.840.10008.5.1.4.1.1.481.11   | RT Segmentation Annotation Storge        |
+| 1.2.840.10008.5.1.4.1.1.481.11   | RT Segmentation Annotation Storage       |
 +----------------------------------+------------------------------------------+
 | 1.2.840.10008.5.1.4.1.1.481.12   | RT Radiation Set Storage                 |
 +----------------------------------+------------------------------------------+

diff --git a/dev/_static/basic.css b/dev/_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/dev/_static/documentation_options.js b/dev/_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: '2.1.0.dev0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,

diff --git a/dev/_static/pygments.css b/dev/_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 */

diff --git a/dev/_static/searchtools.js b/dev/_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/dev/_static/sphinx_highlight.js b/dev/_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/dev/apps/echoscp.html b/dev/apps/echoscp.html
@@ -14,11 +14,11 @@
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <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>
-        <script src="../_static/clipboard.min.js"></script>
-        <script src="../_static/copybutton.js"></script>
+        <script src="../_static/documentation_options.js?v=591fcf0d"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+        <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
+        <script src="../_static/copybutton.js?v=ccdb6887"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -115,12 +115,12 @@
            <div itemprop="articleBody">
 
   <section id="echoscp">
-<h1>echoscp<a class="headerlink" href="#echoscp" title="Permalink to this heading">¶</a></h1>
+<h1>echoscp<a class="headerlink" href="#echoscp" title="Link to this heading">¶</a></h1>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ python -m pynetdicom echoscp [options] port
 </pre></div>
 </div>
 <section id="description">
-<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
+<h2>Description<a class="headerlink" href="#description" title="Link to this heading">¶</a></h2>
 <p>The <code class="docutils literal notranslate"><span class="pre">echoscp</span></code> application implements a Service Class Provider (SCP) for the
 <a class="reference external" href="http://dicom.nema.org/medical/dicom/current/output/chtml/part04/chapter_A.html">Verification</a> service class. It listens for
 incoming association requests on the specified <em>port</em>, and once an association
@@ -129,7 +129,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
 <p>The source code for the application can be found <a class="reference external" href="https://github.com/pydicom/pynetdicom/tree/master/pynetdicom/apps/echoscp">here</a></p>
 </section>
 <section id="usage">
-<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">¶</a></h2>
+<h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a></h2>
 <p>The following example shows what happens when it’s started and receives
 a C-ECHO request from a peer:</p>
 <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$ python -m pynetdicom echoscp 11112
@@ -168,9 +168,9 @@ <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">
 </div>
 </section>
 <section id="options">
-<h2>Options<a class="headerlink" href="#options" title="Permalink to this heading">¶</a></h2>
+<h2>Options<a class="headerlink" href="#options" title="Link to this heading">¶</a></h2>
 <section id="general-options">
-<h3>General Options<a class="headerlink" href="#general-options" title="Permalink to this heading">¶</a></h3>
+<h3>General Options<a class="headerlink" href="#general-options" title="Link to this heading">¶</a></h3>
 <dl class="simple">
 <dt><code class="docutils literal notranslate"><span class="pre">-q</span>&#160;&#160;&#160; <span class="pre">--quiet</span></code></dt><dd><p>quiet mode, prints no warnings or errors</p>
 </dd>
@@ -185,7 +185,7 @@ <h3>General Options<a class="headerlink" href="#general-options" title="Permalin
 </dl>
 </section>
 <section id="network-options">
-<h3>Network Options<a class="headerlink" href="#network-options" title="Permalink to this heading">¶</a></h3>
+<h3>Network Options<a class="headerlink" href="#network-options" title="Link to this heading">¶</a></h3>
 <dl class="simple">
 <dt><code class="docutils literal notranslate"><span class="pre">-aet</span>&#160; <span class="pre">--ae-title</span> <span class="pre">[a]etitle</span> <span class="pre">(str)</span></code></dt><dd><p>set the local AE title (default: <code class="docutils literal notranslate"><span class="pre">ECHOSCP</span></code>)</p>
 </dd>
@@ -200,7 +200,7 @@ <h3>Network Options<a class="headerlink" href="#network-options" title="Permalin
 </dl>
 </section>
 <section id="preferred-transfer-syntaxes">
-<h3>Preferred Transfer Syntaxes<a class="headerlink" href="#preferred-transfer-syntaxes" title="Permalink to this heading">¶</a></h3>
+<h3>Preferred Transfer Syntaxes<a class="headerlink" href="#preferred-transfer-syntaxes" title="Link to this heading">¶</a></h3>
 <dl class="simple">
 <dt><code class="docutils literal notranslate"><span class="pre">-x=</span>&#160;&#160; <span class="pre">--prefer-uncompr</span></code></dt><dd><p>prefer explicit VR local byte order</p>
 </dd>
@@ -214,13 +214,13 @@ <h3>Preferred Transfer Syntaxes<a class="headerlink" href="#preferred-transfer-s
 </section>
 </section>
 <section id="dicom-conformance">
-<h2>DICOM Conformance<a class="headerlink" href="#dicom-conformance" title="Permalink to this heading">¶</a></h2>
+<h2>DICOM Conformance<a class="headerlink" href="#dicom-conformance" title="Link to this heading">¶</a></h2>
 <p>The <code class="docutils literal notranslate"><span class="pre">echoscp</span></code> application supports the Verification service as an SCP. The
 following SOP classes are supported:</p>
 <section id="verification-service">
-<h3>Verification Service<a class="headerlink" href="#verification-service" title="Permalink to this heading">¶</a></h3>
+<h3>Verification Service<a class="headerlink" href="#verification-service" title="Link to this heading">¶</a></h3>
 <section id="sop-classes">
-<h4>SOP Classes<a class="headerlink" href="#sop-classes" title="Permalink to this heading">¶</a></h4>
+<h4>SOP Classes<a class="headerlink" href="#sop-classes" title="Link to this heading">¶</a></h4>
 <table class="docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p>UID</p></th>
@@ -235,7 +235,7 @@ <h4>SOP Classes<a class="headerlink" href="#sop-classes" title="Permalink to thi
 </table>
 </section>
 <section id="transfer-syntaxes">
-<h4>Transfer Syntaxes<a class="headerlink" href="#transfer-syntaxes" title="Permalink to this heading">¶</a></h4>
+<h4>Transfer Syntaxes<a class="headerlink" href="#transfer-syntaxes" title="Link to this heading">¶</a></h4>
 <table class="docutils align-default">
 <thead>
 <tr class="row-odd"><th class="head"><p>UID</p></th>