openmgmt/mkdocs.yml at main · noredistribution/openmgmt · GitHub

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
# Site information
site_name: Open Management
site_url: https://aristanetworks.github.io/openmgmt/
site_author: Arista Networks
site_description: Arista Open Management repository documentation
# Repository information
repo_name: openmgmt on Github
repo_url: https://github.com/aristanetworks/openmgmt
edit_uri: edit/main/docs
# Configuration
theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  favicon: _media/favicon.ico
  features:
    - content.action.edit
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/solid/gears
    annotation: material/plus-circle
extra:
  analytics:
    provider: google
    property: G-4V8W728SS9
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/aristanetworks/openmgmt
    - icon: fontawesome/solid/globe
      link: https://www.arista.com
markdown_extensions:
  - attr_list
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.superfences
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
    # allows list ident with 2 spaces
  - mdx_truly_sane_lists
  - md_in_html #Enable the use of captioned images via techniques shown here: https://squidfunk.github.io/mkdocs-material/reference/images/

extra_css:
  - stylesheets/extra.material.css
nav:
  - Home: index.md
  - Configuration:
    - OpenConfig: configuration/openconfig.md
    - NETCONF: configuration/netconf.md
    - RESTCONF: configuration/restconf.md
    - Certificate Authentication: configuration/mtls.md
    - Security Configuration: configuration/security.md
  - Examples:
    - Ansible: examples/ansible/index.md
    - gNMI clients:
      - gnmi (Arista): examples/gnmi-clients/arista-gnmi/index.md
      - gnmic: examples/gnmi-clients/gnmic/index.md
    - gNMI gateway: examples/gnmi-gateway/index.md
    - gNOI:
      - About gNOI: examples/gnoi/index.md
      - gNOIc: examples/gnoi/gnoic.md
      - gRPCurl: examples/gnoi/grpcurl.md
      - gNOI in Golang: examples/gnoi/gnoicode.md
    - Go Lang: examples/golang/index.md
    - NETCONF:
      - About NETCONF: examples/netconf/index.md
      - ncclient: examples/netconf/ncclient.md
      - NETCONF over SSH: examples/netconf/netconf_over_ssh.md
    - Pygnmi: examples/pygnmi/index.md
    - Pyang: examples/pyang/index.md
    - Pyangbind: examples/pyangbind/index.md
    - RESTCONF:
      - About RESTCONF: examples/restconf/index.md
      - cURL: examples/restconf/curl.md
      - Python: examples/restconf/python.md
    - ygot: examples/ygot/index.md
    - WiFi: examples/WiFi/index.md
  - Telemetry:
    - gnmic:
      - gnmic-prometheus: telemetry/adapters/gnmic/prometheus-grafana-demo/index.md
    - gNMI Dial-out: telemetry/adapters/gnmi-dial-out/index.md
    - kafka-telegraf: telemetry/adapters/kafka/index.md
  - Models: models/index.md
  - Videos: videos/index.md