Added VxLAN to doc

aristanetworks · Jul 4, 2023 · 81d05e5 · 81d05e5
1 parent 5fc80eb
commit 81d05e5
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/docs/advanced_usages/as-python-lib.md b/docs/advanced_usages/as-python-lib.md
@@ -33,7 +33,7 @@ for device in inventory.get_inventory(established_only=True):
     )
 ```
 
-You can find data model for [anta.inventory.AntaInventory](../api/inventory.md) in the [auto-generated documentation](../api/inventory.models.md).
+You can find the ANTA Inventory module [here](../api/inventory.md).
 
 ??? note "How to create your inventory file"
     Please visit this [dedicated section](../usage-inventory-catalog.md) for how to use inventory and catalog files.

diff --git a/docs/api/tests.md b/docs/api/tests.md
@@ -21,6 +21,7 @@ This section describes all the available tests provided by ANTA package.
 - [Software](tests.software.md)
 - [STP](tests.stp.md)
 - [System](tests.system.md)
+- [VxLAN](tests.vxlan.md)
 
 
 

diff --git a/docs/api/tests.vxlan.md b/docs/api/tests.vxlan.md
@@ -0,0 +1,4 @@
+# ANTA catalog for VxLAN tests
+
+::: anta.tests.vxlan
+    heading_level: 3
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -164,12 +164,13 @@ nav:
     - STP: api/tests.stp.md
     - Software: api/tests.software.md
     - System: api/tests.system.md
+    - VxLAN: api/tests.vxlan.md
   - API Documentation:
-    - Inventory module: api/inventory.md
-    - Inventory models:
-      - User Inventory data model: api/inventory.models.input.md
-      - Generated Inventory data model: api/inventory.models.md
-    - Test models: api/models.md
+    - Inventory: 
+      - Inventory module: api/inventory.md
+      - Inventory models: api/inventory.models.input.md
+    - Test:
+      - Test models: api/models.md
     - Result Manager:
       - Result Manager module: api/result_manager.md
       - Result Manager models: api/result_manager_models.md