Deployed e5abd13 to main with MkDocs 1.5.3 and mike 2.0.0

aristanetworks · Jan 9, 2024 · 5a47203 · 5a47203
1 parent bad6c6b
commit 5a47203
Show file tree

Hide file tree

Showing 51 changed files with 487 additions and 600 deletions.
diff --git a/main/advanced_usages/as-python-lib/index.html b/main/advanced_usages/as-python-lib/index.html
@@ -2055,7 +2055,7 @@
   <h1>ANTA as a Python Library</h1>
 
 <!--
-  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -2351,7 +2351,7 @@ <h6 id="antatemplate-class"><a href="../../api/models/#anta.models.AntaTemplate"
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 24, 2023</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 9, 2024</span>
   </span>
 
 

diff --git a/main/advanced_usages/caching/index.html b/main/advanced_usages/caching/index.html
@@ -1977,7 +1977,7 @@
   <h1>Caching in ANTA</h1>
 
 <!--
-  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -2065,7 +2065,7 @@ <h5 id="disable-caching-in-a-child-class-of-antadevice">Disable caching in a chi
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 28, 2023</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 9, 2024</span>
   </span>
 
 

diff --git a/main/advanced_usages/custom-tests/index.html b/main/advanced_usages/custom-tests/index.html
@@ -2199,7 +2199,7 @@
   <h1>Developing ANTA tests</h1>
 
 <!--
-  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -2288,6 +2288,7 @@ <h5 id="instance-attributes">Instance Attributes<a class="headerlink" href="#ins
 
   </div>
 
+
 </div><div class="admonition note">
 <p class="admonition-title">Logger object</p>
 <p>ANTA already provides comprehensive logging at every steps of a test execution. The <a href="../../api/models/#anta.models.AntaTest">AntaTest</a> class also provides a <code>logger</code> attribute that is a Python logger specific to the test instance. See <a href="https://docs.python.org/3/library/logging.html">Python documentation</a> for more information.</p>
@@ -2330,6 +2331,7 @@ <h6 id="input-model"><a href="../../api/models/#anta.models.AntaTest.Input">Inpu
 
   </div>
 
+
 </div><h6 id="resultoverwrite-model"><a href="../../api/models/#anta.models.AntaTest.Input.ResultOverwrite">ResultOverwrite</a> model<a class="headerlink" href="#resultoverwrite-model" title="Permanent link">&para;</a></h6>
 
 
@@ -2355,7 +2357,7 @@ <h6 id="input-model"><a href="../../api/models/#anta.models.AntaTest.Input">Inpu
     </thead>
     <tbody>
         <tr>
-          <td><code>description</code></td>
+          <td><code><span title="anta.models.AntaTest.Input.ResultOverwrite.description">description</span></code></td>
           <td>
                 <code><a class="autorefs autorefs-external" title="typing.Optional" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>]</code>
           </td>
@@ -2366,7 +2368,7 @@ <h6 id="input-model"><a href="../../api/models/#anta.models.AntaTest.Input">Inpu
           </td>
         </tr>
         <tr>
-          <td><code>categories</code></td>
+          <td><code><span title="anta.models.AntaTest.Input.ResultOverwrite.categories">categories</span></code></td>
           <td>
                 <code><a class="autorefs autorefs-external" title="typing.Optional" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="autorefs autorefs-external" title="typing.List" href="https://docs.python.org/3/library/typing.html#typing.List">List</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>]]</code>
           </td>
@@ -2377,7 +2379,7 @@ <h6 id="input-model"><a href="../../api/models/#anta.models.AntaTest.Input">Inpu
           </td>
         </tr>
         <tr>
-          <td><code>custom_field</code></td>
+          <td><code><span title="anta.models.AntaTest.Input.ResultOverwrite.custom_field">custom_field</span></code></td>
           <td>
                 <code><a class="autorefs autorefs-external" title="typing.Optional" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>]</code>
           </td>
@@ -2409,6 +2411,7 @@ <h6 id="input-model"><a href="../../api/models/#anta.models.AntaTest.Input">Inpu
 
   </div>
 
+
 </div><div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The pydantic model is configured using the <a href="https://docs.pydantic.dev/latest/usage/model_config/#extra-attributes"><code>extra=forbid</code></a> that will fail input validation if extra fields are provided.</p>
@@ -2598,7 +2601,7 @@ <h4 id="access-your-custom-tests-in-the-test-catalog">Access your custom tests i
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 22, 2023</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 9, 2024</span>
   </span>
 
 

diff --git a/main/api/catalog/index.html b/main/api/catalog/index.html
@@ -1505,7 +1505,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalog.from_dict" class="md-nav__link">
     <span class="md-ellipsis">
-      from_dict()
+      from_dict
     </span>
   </a>
 
@@ -1514,7 +1514,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalog.from_list" class="md-nav__link">
     <span class="md-ellipsis">
-      from_list()
+      from_list
     </span>
   </a>
 
@@ -1523,7 +1523,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalog.get_tests_by_tags" class="md-nav__link">
     <span class="md-ellipsis">
-      get_tests_by_tags()
+      get_tests_by_tags
     </span>
   </a>
 
@@ -1532,7 +1532,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalog.parse" class="md-nav__link">
     <span class="md-ellipsis">
-      parse()
+      parse
     </span>
   </a>
 
@@ -1556,7 +1556,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaTestDefinition.check_inputs" class="md-nav__link">
     <span class="md-ellipsis">
-      check_inputs()
+      check_inputs
     </span>
   </a>
 
@@ -1565,7 +1565,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaTestDefinition.instantiate_inputs" class="md-nav__link">
     <span class="md-ellipsis">
-      instantiate_inputs()
+      instantiate_inputs
     </span>
   </a>
 
@@ -1589,7 +1589,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalogFile.check_tests" class="md-nav__link">
     <span class="md-ellipsis">
-      check_tests()
+      check_tests
     </span>
   </a>
 
@@ -2011,7 +2011,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalog.from_dict" class="md-nav__link">
     <span class="md-ellipsis">
-      from_dict()
+      from_dict
     </span>
   </a>
 
@@ -2020,7 +2020,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalog.from_list" class="md-nav__link">
     <span class="md-ellipsis">
-      from_list()
+      from_list
     </span>
   </a>
 
@@ -2029,7 +2029,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalog.get_tests_by_tags" class="md-nav__link">
     <span class="md-ellipsis">
-      get_tests_by_tags()
+      get_tests_by_tags
     </span>
   </a>
 
@@ -2038,7 +2038,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalog.parse" class="md-nav__link">
     <span class="md-ellipsis">
-      parse()
+      parse
     </span>
   </a>
 
@@ -2062,7 +2062,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaTestDefinition.check_inputs" class="md-nav__link">
     <span class="md-ellipsis">
-      check_inputs()
+      check_inputs
     </span>
   </a>
 
@@ -2071,7 +2071,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaTestDefinition.instantiate_inputs" class="md-nav__link">
     <span class="md-ellipsis">
-      instantiate_inputs()
+      instantiate_inputs
     </span>
   </a>
 
@@ -2095,7 +2095,7 @@
           <li class="md-nav__item">
   <a href="#anta.catalog.AntaCatalogFile.check_tests" class="md-nav__link">
     <span class="md-ellipsis">
-      check_tests()
+      check_tests
     </span>
   </a>
 
@@ -2127,7 +2127,7 @@
   <h1>Test Catalog</h1>
 
 <!--
-  ~ Copyright (c) 2023 Arista Networks, Inc.
+  ~ Copyright (c) 2023-2024 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
@@ -2138,7 +2138,6 @@ <h1>Test Catalog</h1>
 
 
 
-
 <h2 id="anta.catalog.AntaCatalog" class="doc doc-heading">
           <span class="doc doc-object-name doc-class-name">AntaCatalog</span>
 
@@ -2250,7 +2249,6 @@ <h2 id="anta.catalog.AntaCatalog" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaCatalog.filename" class="doc doc-heading">
           <span class="doc doc-object-name doc-attribute-name">filename</span>
 
@@ -2274,7 +2272,6 @@ <h3 id="anta.catalog.AntaCatalog.filename" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaCatalog.tests" class="doc doc-heading">
           <span class="doc doc-object-name doc-attribute-name">tests</span>
 
@@ -2302,7 +2299,6 @@ <h3 id="anta.catalog.AntaCatalog.tests" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaCatalog.from_dict" class="doc doc-heading">
           <span class="doc doc-object-name doc-function-name">from_dict</span>
 
@@ -2434,7 +2430,6 @@ <h3 id="anta.catalog.AntaCatalog.from_dict" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaCatalog.from_list" class="doc doc-heading">
           <span class="doc doc-object-name doc-function-name">from_list</span>
 
@@ -2526,7 +2521,6 @@ <h3 id="anta.catalog.AntaCatalog.from_list" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaCatalog.get_tests_by_tags" class="doc doc-heading">
           <span class="doc doc-object-name doc-function-name">get_tests_by_tags</span>
 
@@ -2577,7 +2571,6 @@ <h3 id="anta.catalog.AntaCatalog.get_tests_by_tags" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaCatalog.parse" class="doc doc-heading">
           <span class="doc doc-object-name doc-function-name">parse</span>
 
@@ -2671,13 +2664,13 @@ <h3 id="anta.catalog.AntaCatalog.parse" class="doc doc-heading">
 
   </div>
 
+
 </div>
 
 <div class="doc doc-object doc-class">
 
 
 
-
 <h2 id="anta.catalog.AntaTestDefinition" class="doc doc-heading">
           <span class="doc doc-object-name doc-class-name">AntaTestDefinition</span>
 
@@ -2738,7 +2731,6 @@ <h2 id="anta.catalog.AntaTestDefinition" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaTestDefinition.check_inputs" class="doc doc-heading">
           <span class="doc doc-object-name doc-function-name">check_inputs</span>
 
@@ -2779,7 +2771,6 @@ <h3 id="anta.catalog.AntaTestDefinition.check_inputs" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaTestDefinition.instantiate_inputs" class="doc doc-heading">
           <span class="doc doc-object-name doc-function-name">instantiate_inputs</span>
 
@@ -2857,13 +2848,13 @@ <h3 id="anta.catalog.AntaTestDefinition.instantiate_inputs" class="doc doc-headi
 
   </div>
 
+
 </div>
 
 <div class="doc doc-object doc-class">
 
 
 
-
 <h2 id="anta.catalog.AntaCatalogFile" class="doc doc-heading">
           <span class="doc doc-object-name doc-class-name">AntaCatalogFile</span>
 
@@ -2900,7 +2891,6 @@ <h2 id="anta.catalog.AntaCatalogFile" class="doc doc-heading">
 
 
 
-
 <h3 id="anta.catalog.AntaCatalogFile.check_tests" class="doc doc-heading">
           <span class="doc doc-object-name doc-function-name">check_tests</span>
 
@@ -3067,6 +3057,7 @@ <h3 id="anta.catalog.AntaCatalogFile.check_tests" class="doc doc-heading">
 
   </div>
 
+
 </div>
 
 
@@ -3088,7 +3079,7 @@ <h3 id="anta.catalog.AntaCatalogFile.check_tests" class="doc doc-heading">
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 10, 2023</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 9, 2024</span>
   </span>