diff options
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 30 |
1 files changed, 19 insertions, 11 deletions
@@ -2,7 +2,7 @@ site_name: Arista Network Test Automation - ANTA site_author: Khelil Sator site_description: Arista Network Test Automation -copyright: Copyright © 2019 - 2023 Arista Networks +copyright: Copyright © 2019 - 2024 Arista Networks # Repository repo_name: ANTA on Github @@ -76,20 +76,20 @@ extra_javascript: watch: - docs - # Watch src/ directory to reload on changes to docstrings for mkdocstrings plugin. - anta plugins: - mkdocstrings: default_handler: python + custom_templates: docs/templates handlers: python: - paths: [anta] import: - https://docs.python.org/3/objects.inv - https://mkdocstrings.github.io/objects.inv - https://mkdocstrings.github.io/griffe/objects.inv options: + docstring_style: numpy docstring_options: ignore_init_summary: true docstring_section_style: table @@ -106,6 +106,7 @@ plugins: # show_symbol_type_toc: true # default filters here filters: ["!^_[^_]"] + - search: lang: en - git-revision-date-localized: @@ -115,8 +116,8 @@ plugins: markdown_extensions: - attr_list - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - smarty - pymdownx.arithmatex - pymdownx.betterem: @@ -128,7 +129,11 @@ markdown_extensions: - pymdownx.magiclink - pymdownx.mark - pymdownx.smartsymbols - - pymdownx.superfences + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde @@ -156,7 +161,7 @@ nav: - Getting Started: getting-started.md - Installation: requirements-and-installation.md - Inventory & Tests catalog: usage-inventory-catalog.md - - Anta CLI: + - ANTA CLI: - Overview: cli/overview.md - NRFU: cli/nrfu.md - Execute commands: cli/exec.md @@ -170,19 +175,22 @@ nav: - Caching in ANTA: advanced_usages/caching.md - Developing ANTA tests: advanced_usages/custom-tests.md - ANTA as a Python Library: advanced_usages/as-python-lib.md - - Test Catalog Documentation: + - Tests Documentation: - Overview: api/tests.md - AAA: api/tests.aaa.md - BFD: api/tests.bfd.md - Configuration: api/tests.configuration.md - Connectivity: api/tests.connectivity.md - Field Notices: api/tests.field_notices.md + - GreenT: api/tests.greent.md - Hardware: api/tests.hardware.md - Interfaces: api/tests.interfaces.md + - LANZ: api/tests.lanz.md - Logging: api/tests.logging.md - MLAG: api/tests.mlag.md - Multicast: api/tests.multicast.md - Profiles: api/tests.profiles.md + - PTP: api/tests.ptp.md - Routing: - Generic: api/tests.routing.generic.md - BGP: api/tests.routing.bgp.md @@ -191,6 +199,7 @@ nav: - Services: api/tests.services.md - SNMP: api/tests.snmp.md - STP: api/tests.stp.md + - STUN: api/tests.stun.md - Software: api/tests.software.md - System: api/tests.system.md - VXLAN: api/tests.vxlan.md @@ -207,8 +216,7 @@ nav: - Result Manager: - Result Manager module: api/result_manager.md - Result Manager models: api/result_manager_models.md - - Report Manager: - - Report Manager module: api/report_manager.md - - Report Manager models: api/report_manager_models.md + - Report Manager: api/report_manager.md + - Troubleshooting: troubleshooting.md - Contributions: contribution.md - FAQ: faq.md |