summaryrefslogtreecommitdiffstats
path: root/mkdocs.yml
blob: 9dbc60ff568826968e1d75623e65ce63d8b18d21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# Project information
site_name: Arista Network Test Automation - ANTA
site_author: Khelil Sator
site_description: Arista Network Test Automation
copyright: Copyright © 2019 - 2023 Arista Networks

# Repository
repo_name: ANTA on Github
repo_url: https://github.com/arista-netdevops-community/anta

# Configuration
use_directory_urls: true
theme:
  name: material
  features:
    - navigation.instant
    - navigation.top
    - content.tabs.link
    - content.code.copy
    # - toc.integrate
    - toc.follow
    - navigation.indexes
    - content.tabs.link
  highlightjs: true
  hljs_languages:
    - yaml
    - python
    - shell
  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/solid/network-wired
  favicon: imgs/favicon.ico
  font:
    code: Fira Mono
  language: en
  include_search_page: false
  search_index_only: true
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  custom_dir: docs/overrides

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/arista-netdevops-community/anta
    - icon: fontawesome/brands/docker
      link: https://github.com/arista-netdevops-community/anta/pkgs/container/anta
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/anta/
  version:
    provider: mike
    default:
      - stable

extra_css:
  - stylesheets/extra.material.css

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/highlight.min.js

watch:
  - docs
  # Watch src/ directory to reload on changes to docstrings for mkdocstrings plugin.
  - anta

plugins:
  - mkdocstrings:
      default_handler: python
      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_options:
              ignore_init_summary: true
            docstring_section_style: table
            heading_level: 2
            inherited_members: false
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            # sadly symbols are for insiders only
            # https://mkdocstrings.github.io/python/usage/configuration/headings/#show_symbol_type_toc
            # show_symbol_type_heading: true
            # show_symbol_type_toc: true
            # default filters here
            filters: ["!^_[^_]"]
  - search:
      lang: en
  - git-revision-date-localized:
      type: date
  - mike:

markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - smarty
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  # - fontawesome_markdown
  - admonition
  - codehilite:
      guess_lang: true
  - toc:
      separator: "-"
      # permalink: "#"
      permalink: true
      baselevel: 3
  - pymdownx.highlight
  - pymdownx.snippets:
      base_path: docs/snippets
  - pymdownx.superfences
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

# TOC
docs_dir: docs/
nav:
  - Home: README.md
  - Getting Started: getting-started.md
  - Installation: requirements-and-installation.md
  - Inventory & Tests catalog: usage-inventory-catalog.md
  - Anta CLI:
    - Overview: cli/overview.md
    - NRFU: cli/nrfu.md
    - Execute commands: cli/exec.md
    - Inventory from CVP: cli/inv-from-cvp.md
    - Inventory from Ansible: cli/inv-from-ansible.md
    - Get Inventory Information: cli/get-inventory-information.md
    - Check: cli/check.md
    - Helpers: cli/debug.md
    - Tag Management: cli/tag-management.md
  - Advanced Usages:
    - 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:
    - 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
    - Hardware: api/tests.hardware.md
    - Interfaces: api/tests.interfaces.md
    - Logging: api/tests.logging.md
    - MLAG: api/tests.mlag.md
    - Multicast: api/tests.multicast.md
    - Profiles: api/tests.profiles.md
    - Routing:
      - Generic: api/tests.routing.generic.md
      - BGP: api/tests.routing.bgp.md
      - OSPF: api/tests.routing.ospf.md
    - Security: api/tests.security.md
    - Services: api/tests.services.md
    - SNMP: api/tests.snmp.md
    - STP: api/tests.stp.md
    - Software: api/tests.software.md
    - System: api/tests.system.md
    - VXLAN: api/tests.vxlan.md
    - VLAN: api/tests.vlan.md
  - API Documentation:
    - Inventory:
      - Inventory module: api/inventory.md
      - Inventory models: api/inventory.models.input.md
    - Test Catalog: api/catalog.md
    - Device: api/device.md
    - Test:
      - Test models: api/models.md
      - Input Types:  api/types.md
    - 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
  - Contributions: contribution.md
  - FAQ: faq.md