Deployed ea12afc with MkDocs version: 1.6.1

IBM · Oct 15, 2024 · 334ff0e · 334ff0e
1 parent 46d103e
commit 334ff0e
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 10 deletions.
diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css
@@ -26,20 +26,33 @@
   float: right;
 }
 
+/* Parameter headings must be inline, not blocks. */
+.doc-heading-parameter {
+  display: inline;
+}
+
+/* Prefer space on the right, not the left of parameter permalinks. */
+.doc-heading-parameter .headerlink {
+  margin-left: 0 !important;
+  margin-right: 0.2rem;
+}
+
 /* Backward-compatibility: docstring section titles in bold. */
 .doc-section-title {
   font-weight: bold;
 }
 
 /* Symbols in Navigation and ToC. */
-:root,
+:root, :host,
 [data-md-color-scheme="default"] {
+  --doc-symbol-parameter-fg-color: #df50af;
   --doc-symbol-attribute-fg-color: #953800;
   --doc-symbol-function-fg-color: #8250df;
   --doc-symbol-method-fg-color: #8250df;
   --doc-symbol-class-fg-color: #0550ae;
   --doc-symbol-module-fg-color: #5cad0f;
 
+  --doc-symbol-parameter-bg-color: #df50af1a;
   --doc-symbol-attribute-bg-color: #9538001a;
   --doc-symbol-function-bg-color: #8250df1a;
   --doc-symbol-method-bg-color: #8250df1a;
@@ -48,12 +61,14 @@
 }
 
 [data-md-color-scheme="slate"] {
+  --doc-symbol-parameter-fg-color: #ffa8cc;
   --doc-symbol-attribute-fg-color: #ffa657;
   --doc-symbol-function-fg-color: #d2a8ff;
   --doc-symbol-method-fg-color: #d2a8ff;
   --doc-symbol-class-fg-color: #79c0ff;
   --doc-symbol-module-fg-color: #baff79;
 
+  --doc-symbol-parameter-bg-color: #ffa8cc1a;
   --doc-symbol-attribute-bg-color: #ffa6571a;
   --doc-symbol-function-bg-color: #d2a8ff1a;
   --doc-symbol-method-bg-color: #d2a8ff1a;
@@ -68,6 +83,15 @@ code.doc-symbol {
   font-weight: bold;
 }
 
+code.doc-symbol-parameter {
+  color: var(--doc-symbol-parameter-fg-color);
+  background-color: var(--doc-symbol-parameter-bg-color);
+}
+
+code.doc-symbol-parameter::after {
+  content: "param";
+}
+
 code.doc-symbol-attribute {
   color: var(--doc-symbol-attribute-fg-color);
   background-color: var(--doc-symbol-attribute-bg-color);

diff --git a/sitemap.xml b/sitemap.xml
@@ -2,34 +2,34 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://ibm.github.io/tnz/</loc>
-         <lastmod>2024-10-14</lastmod>
+         <lastmod>2024-10-15</lastmod>
     </url>
     <url>
          <loc>https://ibm.github.io/tnz/ati-compat/</loc>
-         <lastmod>2024-10-14</lastmod>
+         <lastmod>2024-10-15</lastmod>
     </url>
     <url>
          <loc>https://ibm.github.io/tnz/ati/</loc>
-         <lastmod>2024-10-14</lastmod>
+         <lastmod>2024-10-15</lastmod>
     </url>
     <url>
          <loc>https://ibm.github.io/tnz/colors/</loc>
-         <lastmod>2024-10-14</lastmod>
+         <lastmod>2024-10-15</lastmod>
     </url>
     <url>
          <loc>https://ibm.github.io/tnz/screen-sizing/</loc>
-         <lastmod>2024-10-14</lastmod>
+         <lastmod>2024-10-15</lastmod>
     </url>
     <url>
          <loc>https://ibm.github.io/tnz/security/</loc>
-         <lastmod>2024-10-14</lastmod>
+         <lastmod>2024-10-15</lastmod>
     </url>
     <url>
          <loc>https://ibm.github.io/tnz/tnz/</loc>
-         <lastmod>2024-10-14</lastmod>
+         <lastmod>2024-10-15</lastmod>
     </url>
     <url>
          <loc>https://ibm.github.io/tnz/zti/</loc>
-         <lastmod>2024-10-14</lastmod>
+         <lastmod>2024-10-15</lastmod>
     </url>
 </urlset>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
diff --git a/tnz/index.html b/tnz/index.html
@@ -163,7 +163,7 @@
 </code></pre></div> <div class="doc doc-contents "> <p>Upload data from file-like object to remote server.</p> </div> </div> <div class="doc doc-object doc-function"> <h5 id=tnz.tnz.Tnz.uploading class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">uploading</span> <a href=#tnz.tnz.Tnz.uploading class=headerlink title="Permanent link">§</a></h5> <div class="doc-signature codehilite"><pre><span></span><code><span class=nf>uploading</span><span class=p>()</span>
 </code></pre></div> <div class="doc doc-contents "> <p>Return bool indicating if currently uploading.</p> </div> </div> <div class="doc doc-object doc-function"> <h5 id=tnz.tnz.Tnz.wait class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">wait</span> <a href=#tnz.tnz.Tnz.wait class=headerlink title="Permanent link">§</a></h5> <div class="doc-signature codehilite"><pre><span></span><code><span class=nf>wait</span><span class=p>(</span><span class=n>timeout</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span> <span class=n>zti</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span> <span class=n>key</span><span class=o>=</span><span class=kc>None</span><span class=p>)</span>
 </code></pre></div> <div class="doc doc-contents "> <p>Wait for event.</p> <p>Returns after timeout seconds or when data is received.</p> </div> </div> <div class="doc doc-object doc-function"> <h5 id=tnz.tnz.Tnz.word_at class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">word_at</span> <a href=#tnz.tnz.Tnz.word_at class=headerlink title="Permanent link">§</a></h5> <div class="doc-signature codehilite"><pre><span></span><code><span class=nf>word_at</span><span class=p>(</span><span class=n>address</span><span class=p>)</span>
-</code></pre></div> <div class="doc doc-contents "> <p>Return the word at the input address.</p> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id=tnz.tnz.TnzError class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TnzError</span> <a href=#tnz.tnz.TnzError class=headerlink title="Permanent link">§</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code>Exception</code></p> <p>General Tnz error.</p> </div> </div> <div class="doc doc-object doc-class"> <h3 id=tnz.tnz.TnzTerminalError class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TnzTerminalError</span> <a href=#tnz.tnz.TnzTerminalError class=headerlink title="Permanent link">§</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-internal" title="tnz.tnz.TnzError" href="#tnz.tnz.TnzError">TnzError</a></code></p> <p>May be related to terminal characteristics.</p> </div> </div> <div class="doc doc-object doc-class"> <h3 id=tnz.tnz.TnzTransferError class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TnzTransferError</span> <a href=#tnz.tnz.TnzTransferError class=headerlink title="Permanent link">§</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code><a class="autorefs autorefs-internal" title="tnz.tnz.TnzError" href="#tnz.tnz.TnzError">TnzError</a></code></p> <p>Error processing file transfer.</p> </div> </div> <h2 id=tnz.tnz-functions>Functions<a href=#tnz.tnz-functions class=headerlink title="Permanent link">§</a></h2> <div class="doc doc-object doc-function"> <h3 id=tnz.tnz.bit6 class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">bit6</span> <a href=#tnz.tnz.bit6 class=headerlink title="Permanent link">§</a></h3> <div class="doc-signature codehilite"><pre><span></span><code><span class=nf>bit6</span><span class=p>(</span><span class=n>control_int</span><span class=p>)</span>
+</code></pre></div> <div class="doc doc-contents "> <p>Return the word at the input address.</p> </div> </div> </div> </div> </div> <div class="doc doc-object doc-class"> <h3 id=tnz.tnz.TnzError class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TnzError</span> <a href=#tnz.tnz.TnzError class=headerlink title="Permanent link">§</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code>Exception</code></p> <p>General Tnz error.</p> </div> </div> <div class="doc doc-object doc-class"> <h3 id=tnz.tnz.TnzTerminalError class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TnzTerminalError</span> <a href=#tnz.tnz.TnzTerminalError class=headerlink title="Permanent link">§</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code>TnzError</code></p> <p>May be related to terminal characteristics.</p> </div> </div> <div class="doc doc-object doc-class"> <h3 id=tnz.tnz.TnzTransferError class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TnzTransferError</span> <a href=#tnz.tnz.TnzTransferError class=headerlink title="Permanent link">§</a></h3> <div class="doc doc-contents "> <p class="doc doc-class-bases"> Bases: <code>TnzError</code></p> <p>Error processing file transfer.</p> </div> </div> <h2 id=tnz.tnz-functions>Functions<a href=#tnz.tnz-functions class=headerlink title="Permanent link">§</a></h2> <div class="doc doc-object doc-function"> <h3 id=tnz.tnz.bit6 class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">bit6</span> <a href=#tnz.tnz.bit6 class=headerlink title="Permanent link">§</a></h3> <div class="doc-signature codehilite"><pre><span></span><code><span class=nf>bit6</span><span class=p>(</span><span class=n>control_int</span><span class=p>)</span>
 </code></pre></div> <div class="doc doc-contents "> <p>Translate 6-bit control characters to printable characters. This is used for bytes that have bits 0 and 1 reserved in order to make the byte a printable character. See figure D-1 in Data Stream Programmers Reference.</p> </div> </div> <div class="doc doc-object doc-function"> <h3 id=tnz.tnz.connect class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">connect</span> <a href=#tnz.tnz.connect class=headerlink title="Permanent link">§</a></h3> <div class="doc-signature codehilite"><pre><span></span><code><span class=nf>connect</span><span class=p>(</span>
     <span class=n>host</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>
     <span class=n>port</span><span class=o>=</span><span class=kc>None</span><span class=p>,</span>