Update docs and coverage

davedoesdev · Nov 9, 2023 · 67f861c · 67f861c
1 parent a4eb349
commit 67f861c
Show file tree

Hide file tree

Showing 14 changed files with 51 additions and 32 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.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: 42f75853b1df228006fdc8413f5a2b0f
+config: 3944fb644cff524c03880bf3672bb799
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '11.2.0',
+    VERSION: '11.3.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -4,10 +4,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; python-dxf 11.2.0 documentation</title>
+    <title>Index &#8212; python-dxf 11.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/nature.css?v=601dbdee" />
-    <script src="_static/documentation_options.js?v=2d832310"></script>
+    <script src="_static/documentation_options.js?v=5c566949"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="#" />
@@ -22,7 +22,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>  
@@ -159,6 +159,8 @@ <h2 id="H">H</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#dxf.hash_file">hash_file() (in module dxf)</a>
+</li>
+      <li><a href="index.html#dxf.DXF.head_manifest_and_response">head_manifest_and_response() (dxf.DXF method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -257,7 +259,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -5,10 +5,10 @@
     <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>dxf module &#8212; python-dxf 11.2.0 documentation</title>
+    <title>dxf module &#8212; python-dxf 11.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/nature.css?v=601dbdee" />
-    <script src="_static/documentation_options.js?v=2d832310"></script>
+    <script src="_static/documentation_options.js?v=5c566949"></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" />
@@ -23,7 +23,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">python-dxf 11.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">python-dxf 11.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dxf module</a></li> 
       </ul>
     </div>  
@@ -70,7 +70,7 @@ <h1>dxf module<a class="headerlink" href="#dxf-module" title="Link to this headi
 <dd><p>Performs API version check</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>verson check response as a string (JSON) and requests.Response</p>
+<dd class="field-odd"><p>version check response as a string (JSON) and requests.Response</p>
 </dd>
 </dl>
 </dd></dl>
@@ -211,6 +211,22 @@ <h1>dxf module<a class="headerlink" href="#dxf-module" title="Link to this headi
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="dxf.DXF.head_manifest_and_response">
+<span class="sig-name descname"><span class="pre">head_manifest_and_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">alias</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Response</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#dxf.DXF.head_manifest_and_response" title="Link to this definition">¶</a></dt>
+<dd><p>Request the manifest for an alias and return the digest and the
+response.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>alias</strong> – Alias name.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><p>Tuple containing the digest as str and the <a class="reference external" href="http://docs.python-requests.org/en/master/api/#requests.Response">requests.Response</a></p>
+</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="dxf.DXF.list_aliases">
 <span class="sig-name descname"><span class="pre">list_aliases</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">batch_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iterate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#dxf.DXF.list_aliases" title="Link to this definition">¶</a></dt>
@@ -609,6 +625,7 @@ <h3><a href="#">Table of Contents</a></h3>
 <li><a class="reference internal" href="#dxf.DXF.get_digest"><code class="docutils literal notranslate"><span class="pre">DXF.get_digest()</span></code></a></li>
 <li><a class="reference internal" href="#dxf.DXF.get_manifest"><code class="docutils literal notranslate"><span class="pre">DXF.get_manifest()</span></code></a></li>
 <li><a class="reference internal" href="#dxf.DXF.get_manifest_and_response"><code class="docutils literal notranslate"><span class="pre">DXF.get_manifest_and_response()</span></code></a></li>
+<li><a class="reference internal" href="#dxf.DXF.head_manifest_and_response"><code class="docutils literal notranslate"><span class="pre">DXF.head_manifest_and_response()</span></code></a></li>
 <li><a class="reference internal" href="#dxf.DXF.list_aliases"><code class="docutils literal notranslate"><span class="pre">DXF.list_aliases()</span></code></a></li>
 <li><a class="reference internal" href="#dxf.DXF.mount_blob"><code class="docutils literal notranslate"><span class="pre">DXF.mount_blob()</span></code></a></li>
 <li><a class="reference internal" href="#dxf.DXF.pull_blob"><code class="docutils literal notranslate"><span class="pre">DXF.pull_blob()</span></code></a></li>
@@ -678,7 +695,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">python-dxf 11.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">python-dxf 11.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">dxf module</a></li> 
       </ul>
     </div>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -4,10 +4,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; python-dxf 11.2.0 documentation</title>
+    <title>Python Module Index &#8212; python-dxf 11.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/nature.css?v=601dbdee" />
-    <script src="_static/documentation_options.js?v=2d832310"></script>
+    <script src="_static/documentation_options.js?v=5c566949"></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" />
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="#" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li> 
       </ul>
     </div>  
@@ -89,7 +89,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="#" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li> 
       </ul>
     </div>

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; python-dxf 11.2.0 documentation</title>
+    <title>Search &#8212; python-dxf 11.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/nature.css?v=601dbdee" />
 
-    <script src="_static/documentation_options.js?v=2d832310"></script>
+    <script src="_static/documentation_options.js?v=5c566949"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/searchtools.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Search</a></li> 
       </ul>
     </div>  
@@ -88,7 +88,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">python-dxf 11.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Search</a></li> 
       </ul>
     </div>