Deployed ca66c4d to main with MkDocs 1.6.0 and mike 2.1.2

aristanetworks · Jul 5, 2024 · b97bd13 · b97bd13
1 parent 4911abb
commit b97bd13
Show file tree

Hide file tree

Showing 9 changed files with 293 additions and 131 deletions.
diff --git a/main/api/catalog/index.html b/main/api/catalog/index.html
diff --git a/main/cli/check/index.html b/main/cli/check/index.html
@@ -2119,12 +2119,14 @@ <h1 id="anta-check-commands">ANTA check commands<a class="headerlink" href="#ant
 <h2 id="checking-the-catalog">Checking the catalog<a class="headerlink" href="#checking-the-catalog" title="Permanent link">&para;</a></h2>
 <div class="highlight"><pre><span></span><code>Usage:<span class="w"> </span>anta<span class="w"> </span>check<span class="w"> </span>catalog<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span>
 
-<span class="w">  </span>Check<span class="w"> </span>that<span class="w"> </span>the<span class="w"> </span>catalog<span class="w"> </span>is<span class="w"> </span>valid
+<span class="w">  </span>Check<span class="w"> </span>that<span class="w"> </span>the<span class="w"> </span>catalog<span class="w"> </span>is<span class="w"> </span>valid.
 
 Options:
-<span class="w">  </span>-c,<span class="w"> </span>--catalog<span class="w"> </span>FILE<span class="w">  </span>Path<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span><span class="nb">test</span><span class="w"> </span>catalog<span class="w"> </span>YAML<span class="w"> </span>file<span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:
-<span class="w">                      </span>ANTA_CATALOG<span class="p">;</span><span class="w"> </span>required<span class="o">]</span>
-<span class="w">  </span>--help<span class="w">              </span>Show<span class="w"> </span>this<span class="w"> </span>message<span class="w"> </span>and<span class="w"> </span>exit.
+<span class="w">  </span>-c,<span class="w"> </span>--catalog<span class="w"> </span>FILE<span class="w">            </span>Path<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span><span class="nb">test</span><span class="w"> </span>catalog<span class="w"> </span>file<span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:
+<span class="w">                                </span>ANTA_CATALOG<span class="p">;</span><span class="w"> </span>required<span class="o">]</span>
+<span class="w">  </span>--catalog-format<span class="w"> </span><span class="o">[</span>yaml<span class="p">|</span>json<span class="o">]</span><span class="w">  </span>Format<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>catalog<span class="w"> </span>file,<span class="w"> </span>either<span class="w"> </span><span class="s1">&#39;yaml&#39;</span><span class="w"> </span>or
+<span class="w">                                </span><span class="s1">&#39;json&#39;</span><span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:<span class="w"> </span>ANTA_CATALOG_FORMAT<span class="o">]</span>
+<span class="w">  </span>--help<span class="w">                        </span>Show<span class="w"> </span>this<span class="w"> </span>message<span class="w"> </span>and<span class="w"> </span>exit.
 </code></pre></div>
 
 
@@ -2146,7 +2148,7 @@ <h2 id="checking-the-catalog">Checking the catalog<a class="headerlink" href="#c
     <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">January 9, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 5, 2024</span>
   </span>
 
 

diff --git a/main/cli/nrfu/index.html b/main/cli/nrfu/index.html
@@ -2630,8 +2630,10 @@ <h2 id="nrfu-command-overview">NRFU Command overview<a class="headerlink" href="
 <span class="w">                                  </span>ANTA_INVENTORY<span class="p">;</span><span class="w"> </span>required<span class="o">]</span>
 <span class="w">  </span>--tags<span class="w"> </span>TEXT<span class="w">                     </span>List<span class="w"> </span>of<span class="w"> </span>tags<span class="w"> </span>using<span class="w"> </span>comma<span class="w"> </span>as<span class="w"> </span>separator:
 <span class="w">                                  </span>tag1,tag2,tag3.<span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:<span class="w"> </span>ANTA_TAGS<span class="o">]</span>
-<span class="w">  </span>-c,<span class="w"> </span>--catalog<span class="w"> </span>FILE<span class="w">              </span>Path<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span><span class="nb">test</span><span class="w"> </span>catalog<span class="w"> </span>YAML<span class="w"> </span>file<span class="w">  </span><span class="o">[</span>env
-<span class="w">                                  </span>var:<span class="w"> </span>ANTA_CATALOG<span class="p">;</span><span class="w"> </span>required<span class="o">]</span>
+<span class="w">  </span>-c,<span class="w"> </span>--catalog<span class="w"> </span>FILE<span class="w">              </span>Path<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span><span class="nb">test</span><span class="w"> </span>catalog<span class="w"> </span>file<span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:
+<span class="w">                                  </span>ANTA_CATALOG<span class="p">;</span><span class="w"> </span>required<span class="o">]</span>
+<span class="w">  </span>--catalog-format<span class="w"> </span><span class="o">[</span>yaml<span class="p">|</span>json<span class="o">]</span><span class="w">    </span>Format<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>catalog<span class="w"> </span>file,<span class="w"> </span>either<span class="w"> </span><span class="s1">&#39;yaml&#39;</span><span class="w"> </span>or
+<span class="w">                                  </span><span class="s1">&#39;json&#39;</span><span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:<span class="w"> </span>ANTA_CATALOG_FORMAT<span class="o">]</span>
 <span class="w">  </span>-d,<span class="w"> </span>--device<span class="w"> </span>TEXT<span class="w">               </span>Run<span class="w"> </span>tests<span class="w"> </span>on<span class="w"> </span>a<span class="w"> </span>specific<span class="w"> </span>device.<span class="w"> </span>Can<span class="w"> </span>be
 <span class="w">                                  </span>provided<span class="w"> </span>multiple<span class="w"> </span>times.
 <span class="w">  </span>-t,<span class="w"> </span>--test<span class="w"> </span>TEXT<span class="w">                 </span>Run<span class="w"> </span>a<span class="w"> </span>specific<span class="w"> </span>test.<span class="w"> </span>Can<span class="w"> </span>be<span class="w"> </span>provided

diff --git a/main/getting-started/index.html b/main/getting-started/index.html
@@ -2507,8 +2507,10 @@ <h3 id="cli">CLI<a class="headerlink" href="#cli" title="Permanent link">&para;<
 <span class="w">                                  </span>ANTA_INVENTORY<span class="p">;</span><span class="w"> </span>required<span class="o">]</span>
 <span class="w">  </span>--tags<span class="w"> </span>TEXT<span class="w">                     </span>List<span class="w"> </span>of<span class="w"> </span>tags<span class="w"> </span>using<span class="w"> </span>comma<span class="w"> </span>as<span class="w"> </span>separator:
 <span class="w">                                  </span>tag1,tag2,tag3.<span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:<span class="w"> </span>ANTA_TAGS<span class="o">]</span>
-<span class="w">  </span>-c,<span class="w"> </span>--catalog<span class="w"> </span>FILE<span class="w">              </span>Path<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span><span class="nb">test</span><span class="w"> </span>catalog<span class="w"> </span>YAML<span class="w"> </span>file<span class="w">  </span><span class="o">[</span>env
-<span class="w">                                  </span>var:<span class="w"> </span>ANTA_CATALOG<span class="p">;</span><span class="w"> </span>required<span class="o">]</span>
+<span class="w">  </span>-c,<span class="w"> </span>--catalog<span class="w"> </span>FILE<span class="w">              </span>Path<span class="w"> </span>to<span class="w"> </span>the<span class="w"> </span><span class="nb">test</span><span class="w"> </span>catalog<span class="w"> </span>file<span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:
+<span class="w">                                  </span>ANTA_CATALOG<span class="p">;</span><span class="w"> </span>required<span class="o">]</span>
+<span class="w">  </span>--catalog-format<span class="w"> </span><span class="o">[</span>yaml<span class="p">|</span>json<span class="o">]</span><span class="w">    </span>Format<span class="w"> </span>of<span class="w"> </span>the<span class="w"> </span>catalog<span class="w"> </span>file,<span class="w"> </span>either<span class="w"> </span><span class="s1">&#39;yaml&#39;</span><span class="w"> </span>or
+<span class="w">                                  </span><span class="s1">&#39;json&#39;</span><span class="w">  </span><span class="o">[</span>env<span class="w"> </span>var:<span class="w"> </span>ANTA_CATALOG_FORMAT<span class="o">]</span>
 <span class="w">  </span>-d,<span class="w"> </span>--device<span class="w"> </span>TEXT<span class="w">               </span>Run<span class="w"> </span>tests<span class="w"> </span>on<span class="w"> </span>a<span class="w"> </span>specific<span class="w"> </span>device.<span class="w"> </span>Can<span class="w"> </span>be
 <span class="w">                                  </span>provided<span class="w"> </span>multiple<span class="w"> </span>times.
 <span class="w">  </span>-t,<span class="w"> </span>--test<span class="w"> </span>TEXT<span class="w">                 </span>Run<span class="w"> </span>a<span class="w"> </span>specific<span class="w"> </span>test.<span class="w"> </span>Can<span class="w"> </span>be<span class="w"> </span>provided

diff --git a/main/objects.inv b/main/objects.inv
diff --git a/main/search/search_index.json b/main/search/search_index.json
diff --git a/main/sitemap.xml.gz b/main/sitemap.xml.gz
diff --git a/main/snippets/anta_nrfu_help.txt b/main/snippets/anta_nrfu_help.txt
@@ -29,8 +29,10 @@ Options:
                                   ANTA_INVENTORY; required]
   --tags TEXT                     List of tags using comma as separator:
                                   tag1,tag2,tag3.  [env var: ANTA_TAGS]
-  -c, --catalog FILE              Path to the test catalog YAML file  [env
-                                  var: ANTA_CATALOG; required]
+  -c, --catalog FILE              Path to the test catalog file  [env var:
+                                  ANTA_CATALOG; required]
+  --catalog-format [yaml|json]    Format of the catalog file, either 'yaml' or
+                                  'json'  [env var: ANTA_CATALOG_FORMAT]
   -d, --device TEXT               Run tests on a specific device. Can be
                                   provided multiple times.
   -t, --test TEXT                 Run a specific test. Can be provided