diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/catalog.md | 1 | ||||
| -rw-r--r-- | docs/api/csv_reporter.md | 13 | ||||
| -rw-r--r-- | docs/api/device.md | 16 | ||||
| -rw-r--r-- | docs/api/inventory.md | 1 | ||||
| -rw-r--r-- | docs/api/md_reporter.md | 13 | ||||
| -rw-r--r-- | docs/api/models.md | 16 | ||||
| -rw-r--r-- | docs/api/reporters.md (renamed from docs/api/report_manager.md) | 5 | ||||
| -rw-r--r-- | docs/api/result_manager.md | 5 | ||||
| -rw-r--r-- | docs/api/result_manager_models.md | 5 | ||||
| -rw-r--r-- | docs/api/runner.md | 1 | ||||
| -rw-r--r-- | docs/api/tests.flow_tracking.md | 20 | ||||
| -rw-r--r-- | docs/api/tests.md | 9 | ||||
| -rw-r--r-- | docs/api/tests.routing.bgp.md | 1 | ||||
| -rw-r--r-- | docs/api/tests.routing.isis.md | 1 | ||||
| -rw-r--r-- | docs/api/tests.routing.ospf.md | 1 | ||||
| -rw-r--r-- | docs/api/types.md | 1 |
16 files changed, 81 insertions, 28 deletions
diff --git a/docs/api/catalog.md b/docs/api/catalog.md index fc719ea..44cc4df 100644 --- a/docs/api/catalog.md +++ b/docs/api/catalog.md @@ -5,6 +5,7 @@ --> ### ::: anta.catalog.AntaCatalog + options: filters: ["!^_[^_]", "!__str__"] diff --git a/docs/api/csv_reporter.md b/docs/api/csv_reporter.md new file mode 100644 index 0000000..0432c45 --- /dev/null +++ b/docs/api/csv_reporter.md @@ -0,0 +1,13 @@ +--- +anta_title: CSV Reporter +--- +<!-- + ~ 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.reporter.csv_reporter + options: + show_root_heading: false + show_root_toc_entry: false diff --git a/docs/api/device.md b/docs/api/device.md index 03cff19..136fec7 100644 --- a/docs/api/device.md +++ b/docs/api/device.md @@ -6,20 +6,20 @@ # AntaDevice base class -## UML representation + - +## ::: anta.device.AntaDevice -### ::: anta.device.AntaDevice options: - filters: ["!^_[^_]", "!__(eq|rich_repr)__"] + filters: ["!^_[^_]", "!__(eq|rich_repr)__", "_collect"] # Async EOS device class -## UML representation + - +<!-- _collect must be last to be kept --> + +## ::: anta.device.AsyncEOSDevice -### ::: anta.device.AsyncEOSDevice options: - filters: ["!^_[^_]", "!__(eq|rich_repr)__"] + filters: ["!^_[^_]", "!__(eq|rich_repr)__", "_collect"] diff --git a/docs/api/inventory.md b/docs/api/inventory.md index 5e4400c..b826b9f 100644 --- a/docs/api/inventory.md +++ b/docs/api/inventory.md @@ -5,6 +5,7 @@ --> ### ::: anta.inventory.AntaInventory + options: filters: ["!^_[^_]", "!__str__"] diff --git a/docs/api/md_reporter.md b/docs/api/md_reporter.md new file mode 100644 index 0000000..7fa1a15 --- /dev/null +++ b/docs/api/md_reporter.md @@ -0,0 +1,13 @@ +--- +anta_title: Markdown Reporter +--- +<!-- + ~ 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.reporter.md_reporter + options: + show_root_heading: false + show_root_toc_entry: false diff --git a/docs/api/models.md b/docs/api/models.md index b0c1e91..1b360de 100644 --- a/docs/api/models.md +++ b/docs/api/models.md @@ -6,20 +6,18 @@ # Test definition -## UML Diagram + - +## ::: anta.models.AntaTest -### ::: anta.models.AntaTest options: filters: ["!^_[^_]", "!__init_subclass__", "!update_progress"] # Command definition -## UML Diagram + - -### ::: anta.models.AntaCommand +## ::: anta.models.AntaCommand !!! warning CLI commands are protected to avoid execution of critical commands such as `reload` or `write erase`. @@ -30,8 +28,6 @@ # Template definition -## UML Diagram + - - -### ::: anta.models.AntaTemplate +## ::: anta.models.AntaTemplate diff --git a/docs/api/report_manager.md b/docs/api/reporters.md index f0e3818..a72e107 100644 --- a/docs/api/report_manager.md +++ b/docs/api/reporters.md @@ -4,4 +4,7 @@ ~ that can be found in the LICENSE file. --> -### ::: anta.reporter.ReportTable +::: anta.reporter + options: + show_root_heading: false + show_root_toc_entry: false diff --git a/docs/api/result_manager.md b/docs/api/result_manager.md index 72e05aa..9fc978a 100644 --- a/docs/api/result_manager.md +++ b/docs/api/result_manager.md @@ -6,10 +6,9 @@ # Result Manager definition -## UML Diagram + - +## ::: anta.result_manager.ResultManager -### ::: anta.result_manager.ResultManager options: filters: ["!^_[^_]", "!^__len__"] diff --git a/docs/api/result_manager_models.md b/docs/api/result_manager_models.md index 096bd03..42e2648 100644 --- a/docs/api/result_manager_models.md +++ b/docs/api/result_manager_models.md @@ -6,10 +6,9 @@ # Test Result model -## UML Diagram + - +## ::: anta.result_manager.models.TestResult -### ::: anta.result_manager.models.TestResult options: filters: ["!^_[^_]", "!__str__"] diff --git a/docs/api/runner.md b/docs/api/runner.md index 27fbaa2..a2de007 100644 --- a/docs/api/runner.md +++ b/docs/api/runner.md @@ -5,5 +5,6 @@ --> ### ::: anta.runner + options: filters: ["!^_[^_]", "!__str__"] diff --git a/docs/api/tests.flow_tracking.md b/docs/api/tests.flow_tracking.md new file mode 100644 index 0000000..0df0b1d --- /dev/null +++ b/docs/api/tests.flow_tracking.md @@ -0,0 +1,20 @@ +--- +anta_title: ANTA catalog for flow tracking 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.flow_tracking + 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 b11f0ba..7dd74c1 100644 --- a/docs/api/tests.md +++ b/docs/api/tests.md @@ -1,11 +1,12 @@ +--- +anta_title: ANTA Tests Landing Page +--- <!-- ~ 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 Landing Page - This section describes all the available tests provided by the ANTA package. ## Available Tests @@ -17,7 +18,8 @@ Here are the tests that we currently provide: - [BFD](tests.bfd.md) - [Configuration](tests.configuration.md) - [Connectivity](tests.connectivity.md) -- [Field Notice](tests.field_notices.md) +- [Field Notices](tests.field_notices.md) +- [Flow Tracking](tests.flow_tracking.md) - [GreenT](tests.greent.md) - [Hardware](tests.hardware.md) - [Interfaces](tests.interfaces.md) @@ -30,6 +32,7 @@ Here are the tests that we currently provide: - [Router Path Selection](tests.path_selection.md) - [Routing Generic](tests.routing.generic.md) - [Routing BGP](tests.routing.bgp.md) +- [Routing ISIS](tests.routing.isis.md) - [Routing OSPF](tests.routing.ospf.md) - [Security](tests.security.md) - [Services](tests.services.md) diff --git a/docs/api/tests.routing.bgp.md b/docs/api/tests.routing.bgp.md index 5c54678..4537ec2 100644 --- a/docs/api/tests.routing.bgp.md +++ b/docs/api/tests.routing.bgp.md @@ -18,3 +18,4 @@ anta_title: ANTA catalog for BGP tests filters: - "!test" - "!render" + - "!^_[^_]" diff --git a/docs/api/tests.routing.isis.md b/docs/api/tests.routing.isis.md index b545f33..bf50c72 100644 --- a/docs/api/tests.routing.isis.md +++ b/docs/api/tests.routing.isis.md @@ -18,3 +18,4 @@ anta_title: ANTA catalog for IS-IS tests filters: - "!test" - "!render" + - "!^_[^_]" diff --git a/docs/api/tests.routing.ospf.md b/docs/api/tests.routing.ospf.md index a01eb50..2fd0cd4 100644 --- a/docs/api/tests.routing.ospf.md +++ b/docs/api/tests.routing.ospf.md @@ -18,3 +18,4 @@ anta_title: ANTA catalog for OSPF tests filters: - "!test" - "!render" + - "!^_[^_]" diff --git a/docs/api/types.md b/docs/api/types.md index 806ab63..a633e04 100644 --- a/docs/api/types.md +++ b/docs/api/types.md @@ -5,6 +5,7 @@ --> ### ::: anta.custom_types + options: show_if_no_docstring: true show_root_full_path: true |