doc: titles

docs/advanced_usages/as-python-lib.md

@@ -14,8 +14,8 @@ ANTA is a Python library that can be used in user applications. This section des
 A device is represented in ANTA as a instance of a subclass of the [AntaDevice](../api/device.md#anta.device.AntaDevice) abstract class.
 There are few abstract methods that needs to be implemented by child classes:
 
-- The [collect()](../api/device.md#anta.device.AntaDevice.collect) coroutine is in charge of collecting outputs of [AntaCommand](../api/models.md#anta.models.AntaCommand) instances.
-- The [refresh()](../api/device.md#anta.device.AntaDevice.refresh) coroutine is in charge of updating attributes of the [AntaDevice](../api/device.md#anta.device.AntaDevice) instance. These attributes are used by [AntaInventory](../api/inventory.md#anta.inventory.AntaInventory) to filter out unreachable devices or by [AntaTest](../api/models.md#anta.models.AntaTest) to skip devices based on their hardware models.
+- The [collect()](../api/device.md#anta.device.AntaDevice.collect) coroutine is in charge of collecting outputs of [AntaCommand](../api/commands.md#anta.models.AntaCommand) instances.
+- The [refresh()](../api/device.md#anta.device.AntaDevice.refresh) coroutine is in charge of updating attributes of the [AntaDevice](../api/device.md#anta.device.AntaDevice) instance. These attributes are used by [AntaInventory](../api/inventory.md#anta.inventory.AntaInventory) to filter out unreachable devices or by [AntaTest](../api/anta_test.md#anta.models.AntaTest) to skip devices based on their hardware models.
 
 The [copy()](../api/device.md#anta.device.AntaDevice.copy) coroutine is used to copy files to and from the device. It does not need to be implemented if tests are not using it.
 
@@ -24,7 +24,7 @@ The [copy()](../api/device.md#anta.device.AntaDevice.copy) coroutine is used to
 The [AsyncEOSDevice](../api/device.md#anta.device.AsyncEOSDevice) class is an implementation of [AntaDevice](../api/device.md#anta.device.AntaDevice) for Arista EOS.
 It uses the [aio-eapi](https://github.com/jeremyschulman/aio-eapi) eAPI client and the [AsyncSSH](https://github.com/ronf/asyncssh) library.
 
-- The [_collect()](../api/device.md#anta.device.AsyncEOSDevice._collect) coroutine collects [AntaCommand](../api/models.md#anta.models.AntaCommand) outputs using eAPI.
+- The [_collect()](../api/device.md#anta.device.AsyncEOSDevice._collect) coroutine collects [AntaCommand](../api/commands.md#anta.models.AntaCommand) outputs using eAPI.
 - The [refresh()](../api/device.md#anta.device.AsyncEOSDevice.refresh) coroutine tries to open a TCP connection on the eAPI port and update the `is_online` attribute accordingly. If the TCP connection succeeds, it sends a `show version` command to gather the hardware model of the device and updates the `established` and `hw_model` attributes.
 - The [copy()](../api/device.md#anta.device.AsyncEOSDevice.copy) coroutine copies files to and from the device using the SCP protocol.
 

docs/advanced_usages/caching.md

@@ -29,7 +29,7 @@ The cache is initialized per `AntaDevice` and uses the following cache key desig
 
 `<device_name>:<uid>`
 
-The `uid` is an attribute of [AntaCommand](../api/models.md#anta.models.AntaCommand), which is a unique identifier generated from the command, version, revision and output format.
+The `uid` is an attribute of [AntaCommand](../api/commands.md#anta.models.AntaCommand), which is a unique identifier generated from the command, version, revision and output format.
 
 Each UID has its own asyncio lock. This design allows coroutines that need to access the cache for different UIDs to do so concurrently. The locks are managed by the `self.cache_locks` dictionary.
 
@@ -75,7 +75,7 @@ There might be scenarios where caching is not wanted. You can disable caching in
 
     This approach effectively disables caching for **ALL** commands sent to devices targeted by the `disable_cache` key.
 
-3. For tests developers, caching can be disabled for a specific [`AntaCommand`](../api/models.md#anta.models.AntaCommand) or [`AntaTemplate`](../api/models.md#anta.models.AntaTemplate) by setting the `use_cache` attribute to `False`. That means the command output will always be collected on the device and therefore, never use caching.
+3. For tests developers, caching can be disabled for a specific [`AntaCommand`](../api/commands.md#anta.models.AntaCommand) or [`AntaTemplate`](../api/commands.md#anta.models.AntaTemplate) by setting the `use_cache` attribute to `False`. That means the command output will always be collected on the device and therefore, never use caching.
 
 ### Disable caching in a child class of `AntaDevice`
 

docs/advanced_usages/custom-tests.md

@@ -13,7 +13,7 @@ ANTA is not only a Python library with a CLI and a collection of built-in tests,
 
 A test is a Python class where a test function is defined and will be run by the framework.
 
-ANTA provides an abstract class [AntaTest](../api/models.md#anta.models.AntaTest). This class does the heavy lifting and provide the logic to define, collect and test data. The code below is an example of a simple test in ANTA, which is an [AntaTest](../api/models.md#anta.models.AntaTest) subclass:
+ANTA provides an abstract class [AntaTest](../api/anta_test.md#anta.models.AntaTest). This class does the heavy lifting and provide the logic to define, collect and test data. The code below is an example of a simple test in ANTA, which is an [AntaTest](../api/anta_test.md#anta.models.AntaTest) subclass:
 
 ````python
 from anta.models import AntaTest, AntaCommand
@@ -51,18 +51,18 @@ class VerifyTemperature(AntaTest):
             self.result.is_failure(f"Device temperature exceeds acceptable limits. Current system status: '{temperature_status}'")
 ````
 
-[AntaTest](../api/models.md#anta.models.AntaTest) also provide more advanced capabilities like [AntaCommand](../api/models.md#anta.models.AntaCommand) templating using the [AntaTemplate](../api/models.md#anta.models.AntaTemplate) class or test inputs definition and validation using [AntaTest.Input](../api/models.md#anta.models.AntaTest.Input) [pydantic](https://docs.pydantic.dev/latest/) model. This will be discussed in the sections below.
+[AntaTest](../api/anta_test.md#anta.models.AntaTest) also provide more advanced capabilities like [AntaCommand](../api/commands.md#anta.models.AntaCommand) templating using the [AntaTemplate](../api/commands.md#anta.models.AntaTemplate) class or test inputs definition and validation using [AntaTest.Input](../api/anta_test.md#anta.models.AntaTest.Input) [pydantic](https://docs.pydantic.dev/latest/) model. This will be discussed in the sections below.
 
 ## AntaTest structure
 
-Full AntaTest API documentation is available in the [API documentation section](../api/models.md#anta.models.AntaTest)
+Full AntaTest API documentation is available in the [API documentation section](../api/anta_test.md#anta.models.AntaTest)
 
 ### Class Attributes
 
 - `name` (`str`, `optional`): Name of the test. Used during reporting. By default set to the Class name.
 - `description` (`str`, `optional`): A human readable description of your test. By default set to the first line of the docstring.
 - `categories` (`list[str]`): A list of categories in which the test belongs.
-- `commands` (`[list[AntaCommand | AntaTemplate]]`): A list of command to collect from devices. This list **must** be a list of [AntaCommand](../api/models.md#anta.models.AntaCommand) or [AntaTemplate](../api/models.md#anta.models.AntaTemplate) instances. Rendering [AntaTemplate](../api/models.md#anta.models.AntaTemplate) instances will be discussed later.
+- `commands` (`[list[AntaCommand | AntaTemplate]]`): A list of command to collect from devices. This list **must** be a list of [AntaCommand](../api/commands.md#anta.models.AntaCommand) or [AntaTemplate](../api/commands.md#anta.models.AntaTemplate) instances. Rendering [AntaTemplate](../api/commands.md#anta.models.AntaTemplate) instances will be discussed later.
 
 > [!INFO]
 > All these class attributes are mandatory. If any attribute is missing, a `NotImplementedError` exception will be raised during class instantiation.
@@ -86,21 +86,21 @@ Full AntaTest API documentation is available in the [API documentation section](
 >
 > - **Logger object**
 >
->     ANTA already provides comprehensive logging at every steps of a test execution. The [AntaTest](../api/models.md#anta.models.AntaTest) class also provides a `logger` attribute that is a Python logger specific to the test instance. See [Python documentation](https://docs.python.org/3/library/logging.html) for more information.
+>     ANTA already provides comprehensive logging at every steps of a test execution. The [AntaTest](../api/anta_test.md#anta.models.AntaTest) class also provides a `logger` attribute that is a Python logger specific to the test instance. See [Python documentation](https://docs.python.org/3/library/logging.html) for more information.
 >
 > - **AntaDevice object**
 >
 >     Even if `device` is not a private attribute, you should not need to access this object in your code.
 
 ### Test Inputs
 
-[AntaTest.Input](../api/models.md#anta.models.AntaTest.Input) is a [pydantic model](https://docs.pydantic.dev/latest/usage/models/) that allow test developers to define their test inputs. [pydantic](https://docs.pydantic.dev/latest/) provides out of the box [error handling](https://docs.pydantic.dev/latest/usage/models/#error-handling) for test input validation based on the type hints defined by the test developer.
+[AntaTest.Input](../api/anta_test.md#anta.models.AntaTest.Input) is a [pydantic model](https://docs.pydantic.dev/latest/usage/models/) that allow test developers to define their test inputs. [pydantic](https://docs.pydantic.dev/latest/) provides out of the box [error handling](https://docs.pydantic.dev/latest/usage/models/#error-handling) for test input validation based on the type hints defined by the test developer.
 
-The base definition of [AntaTest.Input](../api/models.md#anta.models.AntaTest.Input) provides common test inputs for all [AntaTest](../api/models.md#anta.models.AntaTest) instances:
+The base definition of [AntaTest.Input](../api/anta_test.md#anta.models.AntaTest.Input) provides common test inputs for all [AntaTest](../api/anta_test.md#anta.models.AntaTest) instances:
 
 #### Input model
 
-Full `Input` model documentation is available in [API documentation section](../api/models.md#anta.models.AntaTest.Input)
+Full `Input` model documentation is available in [API documentation section](../api/anta_test.md#anta.models.AntaTest.Input)
 
 ::: anta.models.AntaTest.Input
     options:
@@ -118,7 +118,7 @@ Full `Input` model documentation is available in [API documentation section](../
 
 #### ResultOverwrite model
 
-Full `ResultOverwrite` model documentation is available in [API documentation section](../api/models.md#anta.models.AntaTest.Input.ResultOverwrite)
+Full `ResultOverwrite` model documentation is available in [API documentation section](../api/anta_test.md#anta.models.AntaTest.Input.ResultOverwrite)
 
 ::: anta.models.AntaTest.Input.ResultOverwrite
     options:
@@ -138,31 +138,31 @@ Full `ResultOverwrite` model documentation is available in [API documentation se
 
 ### Methods
 
-- [test(self) -> None](../api/models.md#anta.models.AntaTest.test): This is an abstract method that **must** be implemented. It contains the test logic that can access the collected command outputs using the `instance_commands` instance attribute, access the test inputs using the `inputs` instance attribute and **must** set the `result` instance attribute accordingly. It must be implemented using the `AntaTest.anta_test` decorator that provides logging and will collect commands before executing the `test()` method.
-- [render(self, template: AntaTemplate) -> list[AntaCommand]](../api/models.md#anta.models.AntaTest.render): This method only needs to be implemented if [AntaTemplate](../api/models.md#anta.models.AntaTemplate) instances are present in the `commands` class attribute. It will be called for every [AntaTemplate](../api/models.md#anta.models.AntaTemplate) occurrence and **must** return a list of [AntaCommand](../api/models.md#anta.models.AntaCommand) using the [AntaTemplate.render()](../api/models.md#anta.models.AntaTemplate.render) method. It can access test inputs using the `inputs` instance attribute.
+- [test(self) -> None](../api/anta_test.md#anta.models.AntaTest.test): This is an abstract method that **must** be implemented. It contains the test logic that can access the collected command outputs using the `instance_commands` instance attribute, access the test inputs using the `inputs` instance attribute and **must** set the `result` instance attribute accordingly. It must be implemented using the `AntaTest.anta_test` decorator that provides logging and will collect commands before executing the `test()` method.
+- [render(self, template: AntaTemplate) -> list[AntaCommand]](../api/anta_test.md#anta.models.AntaTest.render): This method only needs to be implemented if [AntaTemplate](../api/commands.md#anta.models.AntaTemplate) instances are present in the `commands` class attribute. It will be called for every [AntaTemplate](../api/commands.md#anta.models.AntaTemplate) occurrence and **must** return a list of [AntaCommand](../api/commands.md#anta.models.AntaCommand) using the [AntaTemplate.render()](../api/commands.md#anta.models.AntaTemplate.render) method. It can access test inputs using the `inputs` instance attribute.
 
 ## Test execution
 
 Below is a high level description of the test execution flow in ANTA:
 
-1. ANTA will parse the test catalog to get the list of [AntaTest](../api/models.md#anta.models.AntaTest) subclasses to instantiate and their associated input values. We consider a single [AntaTest](../api/models.md#anta.models.AntaTest) subclass in the following steps.
+1. ANTA will parse the test catalog to get the list of [AntaTest](../api/anta_test.md#anta.models.AntaTest) subclasses to instantiate and their associated input values. We consider a single [AntaTest](../api/anta_test.md#anta.models.AntaTest) subclass in the following steps.
 
-2. ANTA will instantiate the [AntaTest](../api/models.md#anta.models.AntaTest) subclass and a single device will be provided to the test instance. The `Input` model defined in the class will also be instantiated at this moment. If any [ValidationError](https://docs.pydantic.dev/latest/errors/errors/) is raised, the test execution will be stopped.
+2. ANTA will instantiate the [AntaTest](../api/anta_test.md#anta.models.AntaTest) subclass and a single device will be provided to the test instance. The `Input` model defined in the class will also be instantiated at this moment. If any [ValidationError](https://docs.pydantic.dev/latest/errors/errors/) is raised, the test execution will be stopped.
 
-3. If there is any [AntaTemplate](../api/models.md#anta.models.AntaTemplate) instance in the `commands` class attribute, [render()](../api/models.md#anta.models.AntaTest.render) will be called for every occurrence. At this moment, the `instance_commands` attribute has been initialized. If any rendering error occurs, the test execution will be stopped.
+3. If there is any [AntaTemplate](../api/commands.md#anta.models.AntaTemplate) instance in the `commands` class attribute, [render()](../api/anta_test.md#anta.models.AntaTest.render) will be called for every occurrence. At this moment, the `instance_commands` attribute has been initialized. If any rendering error occurs, the test execution will be stopped.
 
 4. The `AntaTest.anta_test` decorator will collect the commands from the device and update the `instance_commands` attribute with the outputs. If any collection error occurs, the test execution will be stopped.
 
-5. The [test()](../api/models.md#anta.models.AntaTest.test) method is executed.
+5. The [test()](../api/anta_test.md#anta.models.AntaTest.test) method is executed.
 
 ## Writing an AntaTest subclass
 
-In this section, we will go into all the details of writing an [AntaTest](../api/models.md#anta.models.AntaTest) subclass.
+In this section, we will go into all the details of writing an [AntaTest](../api/anta_test.md#anta.models.AntaTest) subclass.
 
 ### Class definition
 
-Import [anta.models.AntaTest](../api/models.md#anta.models.AntaTest) and define your own class.
-Define the mandatory class attributes using [anta.models.AntaCommand](../api/models.md#anta.models.AntaCommand), [anta.models.AntaTemplate](../api/models.md#anta.models.AntaTemplate) or both.
+Import [anta.models.AntaTest](../api/anta_test.md#anta.models.AntaTest) and define your own class.
+Define the mandatory class attributes using [anta.models.AntaCommand](../api/commands.md#anta.models.AntaCommand), [anta.models.AntaTemplate](../api/commands.md#anta.models.AntaTemplate) or both.
 
 > [!NOTE]
 > Caching can be disabled per `AntaCommand` or `AntaTemplate` by setting the `use_cache` argument to `False`. For more details about how caching is implemented in ANTA, please refer to [Caching in ANTA](../advanced_usages/caching.md).
@@ -253,7 +253,7 @@ Regarding required, optional and nullable fields, refer to this [documentation](
 
 ### Template rendering
 
-Define the `render()` method if you have [AntaTemplate](../api/models.md#anta.models.AntaTemplate) instances in your `commands` class attribute:
+Define the `render()` method if you have [AntaTemplate](../api/commands.md#anta.models.AntaTemplate) instances in your `commands` class attribute:
 
 ```python
 class <YourTestName>(AntaTest):
@@ -262,7 +262,7 @@ class <YourTestName>(AntaTest):
         return [template.render(<template param>=input_value) for input_value in self.inputs.<input_field>]
 ```
 
-You can access test inputs and render as many [AntaCommand](../api/models.md#anta.models.AntaCommand) as desired.
+You can access test inputs and render as many [AntaCommand](../api/commands.md#anta.models.AntaCommand) as desired.
 
 ### Test definition
 

docs/api/reporters.md → docs/api/anta_test.md

@@ -1,10 +1,13 @@
+---
+anta_title: ANTA Test API
+---
 <!--
   ~ Copyright (c) 2023-2025 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.reporter.ReportJinja
+## ::: anta.models.AntaTest
+
     options:
-        show_root_heading: false
-        show_root_toc_entry: false
+        filters: ["!^_[^_]", "!__init_subclass__", "!update_progress"]

docs/api/catalog.md

@@ -1,3 +1,6 @@
+---
+anta_title: ANTA Catalog API
+---
 <!--
   ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0

docs/api/class-diagram.md

@@ -1,9 +1,16 @@
+---
+anta_title: ANTA Class Diagram
+---
 <!--
   ~ Copyright (c) 2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0
   ~ that can be found in the LICENSE file.
   -->
 
+| Color | Description |
+| -------- | --------- |
+| :fontawesome-solid-square-full:{ .pydantic_pink } | [:simple-pydantic:{ .pydantic_pink } pydantic model](https://docs.pydantic.dev/latest/concepts/models/) |
+
 ``` mermaid
 --8<-- "class-diagram.mmd"
 ```

docs/api/models.md → docs/api/commands.md

@@ -1,21 +1,19 @@
+---
+anta_title: ANTA Commands API
+---
 <!--
   ~ Copyright (c) 2023-2025 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.models.AntaTest
-
-    options:
-        filters: ["!^_[^_]", "!__init_subclass__", "!update_progress"]
-
-## ::: anta.models.AntaCommand
-
 !!! warning
     CLI commands are protected to avoid execution of critical commands such as `reload` or `write erase`.
 
       - Reload command: `^reload\s*\w*`
       - Configure mode: `^conf\w*\s*(terminal|session)*`
       - Write: `^wr\w*\s*\w+`
 
+## ::: anta.models.AntaCommand
+
 ## ::: anta.models.AntaTemplate

docs/api/device.md

@@ -1,3 +1,6 @@
+---
+anta_title: ANTA Device API
+---
 <!--
   ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0

docs/api/inventory.md

@@ -1,3 +1,6 @@
+---
+anta_title: ANTA Inventory API
+---
 <!--
   ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0

docs/api/result_manager.md → docs/api/result.md

@@ -1,3 +1,6 @@
+---
+anta_title: ANTA Result API
+---
 <!--
   ~ Copyright (c) 2023-2025 Arista Networks, Inc.
   ~ Use of this source code is governed by the Apache License 2.0