meraki-client-python/mkdocs.yml at main · ollipa/meraki-client-python · 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
site_name: Meraki Dashboard Python client
site_description: meraki-client - Python client for Meraki Dashboard API
site_url: https://meraki-client.readthedocs.io/en/latest/
theme:
  name: material
  features:
    - content.code.annotate
    - navigation.expand
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
extra_css:
  - assets/extra.css
repo_name: meraki-client-python
repo_url: https://github.com/ollipa/meraki-client-python
edit_uri: ""
watch:
  - README.md
  - CONTRIBUTING.md
  - CHANGELOG.md
  - meraki_client/

nav:
  - Overview: index.md
  - User Guide:
      - Getting started: user_guide/getting_started.md
      - Using pagination: user_guide/pagination.md
      - Using batch endpoints: user_guide/batch_endpoints.md
  - Contributing: contributing.md
  - Changelog: changelog.md
  - API Reference:
      - Clients: api_reference/index.md
      - Exceptions: api_reference/exceptions.md
      - Administered: api_reference/administered.md
      - Appliance: api_reference/appliance.md
      - Camera: api_reference/camera.md
      - Campus Gateway: api_reference/campus_gateway.md
      - Cellular Gateway: api_reference/cellular_gateway.md
      - Devices: api_reference/devices.md
      - Insight: api_reference/insight.md
      - Licensing: api_reference/licensing.md
      - Networks: api_reference/networks.md
      - Organizations: api_reference/organizations.md
      - Sensor: api_reference/sensor.md
      - Systems Manager: api_reference/sm.md
      - Spaces: api_reference/spaces.md
      - Switch: api_reference/switch.md
      - Wireless: api_reference/wireless.md
      - Wireless Controller: api_reference/wireless_controller.md
      - Batch:
          - Appliance: api_reference/batch_appliance.md
          - Camera: api_reference/batch_camera.md
          - Campus Gateway: api_reference/batch_campus_gateway.md
          - Cellular Gateway: api_reference/batch_cellular_gateway.md
          - Devices: api_reference/batch_devices.md
          - Insight: api_reference/batch_insight.md
          - Networks: api_reference/batch_networks.md
          - Organizations: api_reference/batch_organizations.md
          - Sensor: api_reference/batch_sensor.md
          - Systems Manager: api_reference/batch_sm.md
          - Spaces: api_reference/batch_spaces.md
          - Switch: api_reference/batch_switch.md
          - Wireless: api_reference/batch_wireless.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            filters:
              - "!^_"
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            docstring_section_style: list
            modernize_annotations: true
            show_signature: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - markdown_include.include:
      base_path: docs