summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/runner.md9
-rw-r--r--docs/api/tests.avt.md20
-rw-r--r--docs/api/tests.md2
-rw-r--r--docs/api/tests.path_selection.md20
-rw-r--r--docs/api/tests.routing.isis.md20
5 files changed, 71 insertions, 0 deletions
diff --git a/docs/api/runner.md b/docs/api/runner.md
new file mode 100644
index 0000000..27fbaa2
--- /dev/null
+++ b/docs/api/runner.md
@@ -0,0 +1,9 @@
+<!--
+ ~ 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.
+ -->
+
+### ::: anta.runner
+ options:
+ filters: ["!^_[^_]", "!__str__"]
diff --git a/docs/api/tests.avt.md b/docs/api/tests.avt.md
new file mode 100644
index 0000000..f9e1acf
--- /dev/null
+++ b/docs/api/tests.avt.md
@@ -0,0 +1,20 @@
+---
+anta_title: ANTA catalog for Adaptive Virtual Topology (AVT) tests
+---
+<!--
+ ~ 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.
+ -->
+
+::: anta.tests.avt
+ options:
+ show_root_heading: false
+ show_root_toc_entry: false
+ show_bases: false
+ merge_init_into_class: false
+ anta_hide_test_module_description: true
+ show_labels: true
+ filters:
+ - "!test"
+ - "!render"
diff --git a/docs/api/tests.md b/docs/api/tests.md
index 1db3a8b..b11f0ba 100644
--- a/docs/api/tests.md
+++ b/docs/api/tests.md
@@ -13,6 +13,7 @@ This section describes all the available tests provided by the ANTA package.
Here are the tests that we currently provide:
- [AAA](tests.aaa.md)
+- [Adaptive Virtual Topology](tests.avt.md)
- [BFD](tests.bfd.md)
- [Configuration](tests.configuration.md)
- [Connectivity](tests.connectivity.md)
@@ -26,6 +27,7 @@ Here are the tests that we currently provide:
- [Multicast](tests.multicast.md)
- [Profiles](tests.profiles.md)
- [PTP](tests.ptp.md)
+- [Router Path Selection](tests.path_selection.md)
- [Routing Generic](tests.routing.generic.md)
- [Routing BGP](tests.routing.bgp.md)
- [Routing OSPF](tests.routing.ospf.md)
diff --git a/docs/api/tests.path_selection.md b/docs/api/tests.path_selection.md
new file mode 100644
index 0000000..b7f6b46
--- /dev/null
+++ b/docs/api/tests.path_selection.md
@@ -0,0 +1,20 @@
+---
+anta_title: ANTA catalog for Router path-selection tests
+---
+<!--
+ ~ 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.
+ -->
+
+::: anta.tests.path_selection
+ options:
+ show_root_heading: false
+ show_root_toc_entry: false
+ show_bases: false
+ merge_init_into_class: false
+ anta_hide_test_module_description: true
+ show_labels: true
+ filters:
+ - "!test"
+ - "!render"
diff --git a/docs/api/tests.routing.isis.md b/docs/api/tests.routing.isis.md
new file mode 100644
index 0000000..b545f33
--- /dev/null
+++ b/docs/api/tests.routing.isis.md
@@ -0,0 +1,20 @@
+---
+anta_title: ANTA catalog for IS-IS tests
+---
+<!--
+ ~ 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.
+ -->
+
+::: anta.tests.routing.isis
+ options:
+ show_root_heading: false
+ show_root_toc_entry: false
+ show_bases: false
+ merge_init_into_class: false
+ anta_hide_test_module_description: true
+ show_labels: true
+ filters:
+ - "!test"
+ - "!render"