doc: More doc cleaning for tests (#592)

docs/README.md

@@ -4,14 +4,14 @@
   ~ that can be found in the LICENSE file.
   -->
 
-| **Code**       | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Numpy](https://img.shields.io/badge/Docstring_format-numpy-blue)](https://numpydoc.readthedocs.io/en/latest/format.html) | 
+# Arista Network Test Automation (ANTA) Framework
+
+| **Code**       | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Numpy](https://img.shields.io/badge/Docstring_format-numpy-blue)](https://numpydoc.readthedocs.io/en/latest/format.html) |
 | :------------: | :-------|
 | **License**    | [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](https://github.com/arista-netdevops-community/anta/blob/main/LICENSE) |
 | **GitHub**     | [![CI](https://github.com/arista-netdevops-community/anta/actions/workflows/code-testing.yml/badge.svg)](https://github.com/arista-netdevops-community/anta/actions/workflows/code-testing.yml) ![Coverage](https://raw.githubusercontent.com/arista-netdevops-community/anta/coverage-badge/latest-release-coverage.svg) ![Commit](https://img.shields.io/github/last-commit/arista-netdevops-community/anta) ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/arista-netdevops-community/anta) [![Github release](https://img.shields.io/github/release/arista-netdevops-community/anta.svg)](https://github.com/arista-netdevops-community/anta/releases/) [![Contributors](https://img.shields.io/github/contributors/arista-netdevops-community/anta)](https://github.com/arista-netdevops-community/anta/graphs/contributors) |
 | **PyPi**       | ![PyPi Version](https://img.shields.io/pypi/v/anta) ![Python Versions](https://img.shields.io/pypi/pyversions/anta) ![Python format](https://img.shields.io/pypi/format/anta) ![PyPI - Downloads](https://img.shields.io/pypi/dm/anta) |
 
-# Arista Network Test Automation (ANTA) Framework
-
 ANTA is Python framework that automates tests for Arista devices.
 
 - ANTA provides a [set of tests](api/tests.md) to validate the state of your network

docs/api/tests.aaa.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for AAA 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 catalog for AAA tests
-
 ::: anta.tests.aaa
     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"

docs/api/tests.bfd.md

@@ -1,18 +1,20 @@
+---
+anta_title: ANTA catalog for BFD 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 catalog for BFD tests
-
 ::: anta.tests.bfd
     options:
       show_root_heading: false
       show_root_toc_entry: false
       show_bases: false
       merge_init_into_class: false
       show_labels: true
+      anta_hide_test_module_description: true
       filters:
         - "!test"
         - "!render"

docs/api/tests.configuration.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for device configuration 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 catalog for device configuration tests
-
 ::: anta.tests.configuration
     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"

docs/api/tests.connectivity.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for connectivity 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 catalog for connectivity tests
-
 ::: anta.tests.connectivity
     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"

docs/api/tests.field_notices.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for Field Notices 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 catalog for Field Notices tests
-
 ::: anta.tests.field_notices
     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"

docs/api/tests.greent.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for GreenT 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 catalog for GreenT tests
-
 ::: anta.tests.greent
     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"

docs/api/tests.hardware.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for hardware 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 catalog for hardware tests
-
 ::: anta.tests.hardware
     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"

docs/api/tests.interfaces.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for interfaces 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 catalog for interfaces tests
-
 ::: anta.tests.interfaces
     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"

docs/api/tests.lanz.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for LANZ 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 catalog for LANZ tests
-
 ::: anta.tests.lanz
     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"

docs/api/tests.logging.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for logging 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 catalog for logging tests
-
 ::: anta.tests.logging
     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"

docs/api/tests.mlag.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for MLAG 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 catalog for MLAG tests
-
 ::: anta.tests.mlag
     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"

docs/api/tests.multicast.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for multicast and IGMP 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 catalog for multicast and IGMP tests
-
 ::: anta.tests.multicast
     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"

docs/api/tests.profiles.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for profiles 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 catalog for profiles tests
-
 ::: anta.tests.profiles
     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"

docs/api/tests.ptp.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for PTP 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 catalog for PTP tests
-
 ::: anta.tests.ptp
     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"

docs/api/tests.routing.bgp.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for BGP 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 catalog for BGP tests
-
 ::: anta.tests.routing.bgp
     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"

docs/api/tests.routing.generic.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for generic routing 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 catalog for generic routing tests
-
 ::: anta.tests.routing.generic
     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"

docs/api/tests.routing.ospf.md

@@ -1,17 +1,19 @@
+---
+anta_title: ANTA catalog for OSPF 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 catalog for OSPF tests
-
 ::: anta.tests.routing.ospf
     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"