Deployed f525ffb to main with MkDocs 1.6.0 and mike 2.1.2

aristanetworks · Aug 8, 2024 · e04459a · e04459a
1 parent 4a92012
commit e04459a
Show file tree

Hide file tree

Showing 63 changed files with 584 additions and 448 deletions.
diff --git a/main/404.html b/main/404.html
@@ -16,7 +16,7 @@
 
 
       <link rel="icon" href="/imgs/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.31">
 
 
 

diff --git a/main/advanced_usages/as-python-lib/index.html b/main/advanced_usages/as-python-lib/index.html
@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../imgs/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.31">
 
 
 

diff --git a/main/advanced_usages/caching/index.html b/main/advanced_usages/caching/index.html
@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../imgs/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.31">
 
 
 

diff --git a/main/advanced_usages/custom-tests/index.html b/main/advanced_usages/custom-tests/index.html
@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../imgs/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.31">
 
 
 

diff --git a/main/api/catalog/index.html b/main/api/catalog/index.html
diff --git a/main/api/device/index.html b/main/api/device/index.html
@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../imgs/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.31">
 
 
 
@@ -1649,9 +1649,11 @@
 
     <!-- Table of contents list -->
 
-  </li>
-
-        <!-- Courtesy of https://github.com/squidfunk/mkdocs-material/issues/4827#issuecomment-1869812019 -->
+      <nav class="md-nav" aria-label="UML representation">
+        <ul class="md-nav__list">
+
+
+            <!-- Courtesy of https://github.com/squidfunk/mkdocs-material/issues/4827#issuecomment-1869812019 -->
 <li class="md-nav__item">
     <a href="#anta.device.AntaDevice" class="md-nav__link">
       <span class="md-ellipsis">
@@ -1752,6 +1754,12 @@
       </nav>
 
   </li>
+
+
+        </ul>
+      </nav>
+
+  </li>
 
     </ul>
 
@@ -2201,9 +2209,11 @@
 
     <!-- Table of contents list -->
 
-  </li>
-
-        <!-- Courtesy of https://github.com/squidfunk/mkdocs-material/issues/4827#issuecomment-1869812019 -->
+      <nav class="md-nav" aria-label="UML representation">
+        <ul class="md-nav__list">
+
+
+            <!-- Courtesy of https://github.com/squidfunk/mkdocs-material/issues/4827#issuecomment-1869812019 -->
 <li class="md-nav__item">
     <a href="#anta.device.AntaDevice" class="md-nav__link">
       <span class="md-ellipsis">
@@ -2304,6 +2314,12 @@
       </nav>
 
   </li>
+
+
+        </ul>
+      </nav>
+
+  </li>
 
     </ul>
 
@@ -2340,11 +2356,11 @@ <h2 id="uml-representation">UML representation<a class="headerlink" href="#uml-r
 
 
 
-<h2 id="anta.device.AntaDevice" class="doc doc-heading">
+<h3 id="anta.device.AntaDevice" class="doc doc-heading">
             <span class="doc doc-object-name doc-class-name">AntaDevice</span>
 
 
-<a href="#anta.device.AntaDevice" class="headerlink" title="Permanent link">&para;</a></h2>
+<a href="#anta.device.AntaDevice" class="headerlink" title="Permanent link">&para;</a></h3>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">AntaDevice</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">tags</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">disable_cache</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span>
 </code></pre></div>
 
@@ -2452,15 +2468,15 @@ <h2 id="anta.device.AntaDevice" class="doc doc-heading">
 
 
 
-<h3 id="anta.device.AntaDevice.cache_statistics" class="doc doc-heading">
+<h4 id="anta.device.AntaDevice.cache_statistics" class="doc doc-heading">
             <span class="doc doc-object-name doc-attribute-name">cache_statistics</span>
 
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-property"><code>property</code></small>
   </span>
 
-<a href="#anta.device.AntaDevice.cache_statistics" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.device.AntaDevice.cache_statistics" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="n">cache_statistics</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span>
 </code></pre></div>
 
@@ -2476,11 +2492,11 @@ <h3 id="anta.device.AntaDevice.cache_statistics" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-<h3 id="anta.device.AntaDevice.__hash__" class="doc doc-heading">
+<h4 id="anta.device.AntaDevice.__hash__" class="doc doc-heading">
             <span class="doc doc-object-name doc-function-name">__hash__</span>
 
 
-<a href="#anta.device.AntaDevice.__hash__" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.device.AntaDevice.__hash__" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="fm">__hash__</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">int</span>
 </code></pre></div>
 
@@ -2504,15 +2520,15 @@ <h3 id="anta.device.AntaDevice.__hash__" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-<h3 id="anta.device.AntaDevice.collect" class="doc doc-heading">
+<h4 id="anta.device.AntaDevice.collect" class="doc doc-heading">
             <span class="doc doc-object-name doc-function-name">collect</span>
 
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
-<a href="#anta.device.AntaDevice.collect" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.device.AntaDevice.collect" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">collect</span><span class="p">(</span><span class="n">command</span><span class="p">:</span> <span class="n">AntaCommand</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">collection_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
@@ -2596,15 +2612,15 @@ <h3 id="anta.device.AntaDevice.collect" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-<h3 id="anta.device.AntaDevice.collect_commands" class="doc doc-heading">
+<h4 id="anta.device.AntaDevice.collect_commands" class="doc doc-heading">
             <span class="doc doc-object-name doc-function-name">collect_commands</span>
 
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
-<a href="#anta.device.AntaDevice.collect_commands" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.device.AntaDevice.collect_commands" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">collect_commands</span><span class="p">(</span><span class="n">commands</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">AntaCommand</span><span class="p">],</span> <span class="o">*</span><span class="p">,</span> <span class="n">collection_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
@@ -2640,15 +2656,15 @@ <h3 id="anta.device.AntaDevice.collect_commands" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-<h3 id="anta.device.AntaDevice.copy" class="doc doc-heading">
+<h4 id="anta.device.AntaDevice.copy" class="doc doc-heading">
             <span class="doc doc-object-name doc-function-name">copy</span>
 
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
-<a href="#anta.device.AntaDevice.copy" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.device.AntaDevice.copy" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">copy</span><span class="p">(</span><span class="n">sources</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Path</span><span class="p">],</span> <span class="n">destination</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">direction</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;to&#39;</span><span class="p">,</span> <span class="s1">&#39;from&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;from&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
@@ -2697,7 +2713,7 @@ <h3 id="anta.device.AntaDevice.copy" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-<h3 id="anta.device.AntaDevice.refresh" class="doc doc-heading">
+<h4 id="anta.device.AntaDevice.refresh" class="doc doc-heading">
             <span class="doc doc-object-name doc-function-name">refresh</span>
 
 
@@ -2706,7 +2722,7 @@ <h3 id="anta.device.AntaDevice.refresh" class="doc doc-heading">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
-<a href="#anta.device.AntaDevice.refresh" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.device.AntaDevice.refresh" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">refresh</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
@@ -2761,11 +2777,11 @@ <h2 id="uml-representation_1">UML representation<a class="headerlink" href="#uml
 
 
 
-<h2 id="anta.device.AsyncEOSDevice" class="doc doc-heading">
+<h3 id="anta.device.AsyncEOSDevice" class="doc doc-heading">
             <span class="doc doc-object-name doc-class-name">AsyncEOSDevice</span>
 
 
-<a href="#anta.device.AsyncEOSDevice" class="headerlink" title="Permanent link">&para;</a></h2>
+<a href="#anta.device.AsyncEOSDevice" class="headerlink" title="Permanent link">&para;</a></h3>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">AsyncEOSDevice</span><span class="p">(</span><span class="n">host</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">enable_password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">port</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">ssh_port</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="mi">22</span><span class="p">,</span> <span class="n">tags</span><span class="p">:</span> <span class="nb">set</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">proto</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;http&#39;</span><span class="p">,</span> <span class="s1">&#39;https&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;https&#39;</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">enable</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">insecure</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">disable_cache</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span>
 </code></pre></div>
 
@@ -2944,15 +2960,15 @@ <h2 id="anta.device.AsyncEOSDevice" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-<h3 id="anta.device.AsyncEOSDevice.copy" class="doc doc-heading">
+<h4 id="anta.device.AsyncEOSDevice.copy" class="doc doc-heading">
             <span class="doc doc-object-name doc-function-name">copy</span>
 
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
-<a href="#anta.device.AsyncEOSDevice.copy" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.device.AsyncEOSDevice.copy" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">copy</span><span class="p">(</span><span class="n">sources</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Path</span><span class="p">],</span> <span class="n">destination</span><span class="p">:</span> <span class="n">Path</span><span class="p">,</span> <span class="n">direction</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="s1">&#39;to&#39;</span><span class="p">,</span> <span class="s1">&#39;from&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;from&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 
@@ -3048,15 +3064,15 @@ <h3 id="anta.device.AsyncEOSDevice.copy" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-<h3 id="anta.device.AsyncEOSDevice.refresh" class="doc doc-heading">
+<h4 id="anta.device.AsyncEOSDevice.refresh" class="doc doc-heading">
             <span class="doc doc-object-name doc-function-name">refresh</span>
 
 
   <span class="doc doc-labels">
       <small class="doc doc-label doc-label-async"><code>async</code></small>
   </span>
 
-<a href="#anta.device.AsyncEOSDevice.refresh" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.device.AsyncEOSDevice.refresh" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">refresh</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span>
 </code></pre></div>
 

diff --git a/main/api/inventory.models.input/index.html b/main/api/inventory.models.input/index.html
@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../imgs/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.31">
 
 
 
@@ -2245,11 +2245,11 @@ <h1>Inventory models</h1>
 
 
 
-<h2 id="anta.inventory.models.AntaInventoryInput" class="doc doc-heading">
+<h3 id="anta.inventory.models.AntaInventoryInput" class="doc doc-heading">
             <span class="doc doc-object-name doc-class-name">AntaInventoryInput</span>
 
 
-<a href="#anta.inventory.models.AntaInventoryInput" class="headerlink" title="Permanent link">&para;</a></h2>
+<a href="#anta.inventory.models.AntaInventoryInput" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
     <div class="doc doc-contents first">
@@ -2276,11 +2276,11 @@ <h2 id="anta.inventory.models.AntaInventoryInput" class="doc doc-heading">
 <div class="doc doc-object doc-function">
 
 
-<h3 id="anta.inventory.models.AntaInventoryInput.yaml" class="doc doc-heading">
+<h4 id="anta.inventory.models.AntaInventoryInput.yaml" class="doc doc-heading">
             <span class="doc doc-object-name doc-function-name">yaml</span>
 
 
-<a href="#anta.inventory.models.AntaInventoryInput.yaml" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#anta.inventory.models.AntaInventoryInput.yaml" class="headerlink" title="Permanent link">&para;</a></h4>
 <div class="doc-signature highlight"><pre><span></span><code><span class="nf">yaml</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span>
 </code></pre></div>
 
@@ -2357,11 +2357,11 @@ <h3 id="anta.inventory.models.AntaInventoryInput.yaml" class="doc doc-heading">
 
 
 
-<h2 id="anta.inventory.models.AntaInventoryHost" class="doc doc-heading">
+<h3 id="anta.inventory.models.AntaInventoryHost" class="doc doc-heading">
             <span class="doc doc-object-name doc-class-name">AntaInventoryHost</span>
 
 
-<a href="#anta.inventory.models.AntaInventoryHost" class="headerlink" title="Permanent link">&para;</a></h2>
+<a href="#anta.inventory.models.AntaInventoryHost" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
     <div class="doc doc-contents first">
@@ -2428,11 +2428,11 @@ <h2 id="anta.inventory.models.AntaInventoryHost" class="doc doc-heading">
 
 
 
-<h2 id="anta.inventory.models.AntaInventoryNetwork" class="doc doc-heading">
+<h3 id="anta.inventory.models.AntaInventoryNetwork" class="doc doc-heading">
             <span class="doc doc-object-name doc-class-name">AntaInventoryNetwork</span>
 
 
-<a href="#anta.inventory.models.AntaInventoryNetwork" class="headerlink" title="Permanent link">&para;</a></h2>
+<a href="#anta.inventory.models.AntaInventoryNetwork" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
     <div class="doc doc-contents first">
@@ -2497,11 +2497,11 @@ <h2 id="anta.inventory.models.AntaInventoryNetwork" class="doc doc-heading">
 
 
 
-<h2 id="anta.inventory.models.AntaInventoryRange" class="doc doc-heading">
+<h3 id="anta.inventory.models.AntaInventoryRange" class="doc doc-heading">
             <span class="doc doc-object-name doc-class-name">AntaInventoryRange</span>
 
 
-<a href="#anta.inventory.models.AntaInventoryRange" class="headerlink" title="Permanent link">&para;</a></h2>
+<a href="#anta.inventory.models.AntaInventoryRange" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
     <div class="doc doc-contents first">