netpulse/mkdocs.yml at master · scitix/netpulse · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
site_name: NetPulse Documentation
site_description: NetPulse distributed network device management API server
site_author: NetPulse Team
site_url: https://netpulse.readthedocs.io/

use_directory_urls: false

# Docs directory
docs_dir: docs

# Repository
repo_name: scitix/netpulse
repo_url: https://github.com/scitix/netpulse

# Copyright
copyright: Copyright &copy; 2025 NetPulse Team

# Theme
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - search.suggest
    - search.highlight
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - navigation.footer
    - navigation.tracking
    - navigation.indexes
    - navigation.prune

  toc:
    depth: 2

  # Custom styles
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Follow system settings
  logo: assets/images/logo.svg
  favicon: assets/images/favicon.ico

# Plugins
plugins:
  - search

# Markdown extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - tables
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.tabbed
  - pymdownx.tasklist
  - pymdownx.caret
  - pymdownx.smartsymbols
  - pymdownx.arithmatex:
      generic: true

  # Only display 2 levels in the table of contents
  - toc:
      permalink: true
      baselevel: 1
      toc_depth: 2

# Navigation
nav:
  - Home: en/index.md
  - Getting Started:
      - Quick Start: en/getting-started/quick-start.md
      - Basic Concepts: en/getting-started/basic-concepts.md
      - Deployment Guide: en/getting-started/deployment-guide.md
      - Postman Guide: en/getting-started/postman-guide.md
  - API Reference:
      - API Overview: en/api/api-overview.md
      - Device Operation API: en/api/device-api.md
      - Template Operation API: en/api/template-api.md
      - Job Management API: en/api/job-api.md
      - API Examples: en/api/api-examples.md
      - API Best Practices: en/api/api-best-practices.md
  - Driver Usage:
      - Driver Selection: en/drivers/index.md
      - Netmiko Driver: en/drivers/netmiko.md
      - NAPALM Driver: en/drivers/napalm.md
      - PyEAPI Driver: en/drivers/pyeapi.md
      - Paramiko Driver: en/drivers/paramiko.md
  - Technical Architecture:
      - Architecture Overview: en/architecture/architecture-overview.md
      - Plugin System: en/architecture/plugin-system.md
      - Driver System: en/architecture/driver-system.md
      - Template System: en/architecture/template-system.md
      - Scheduler System: en/architecture/scheduler-system.md
      - Webhook System: en/architecture/webhook-system.md
  - Reference Manual:
      - Configuration Guide: en/reference/configuration-guide.md
      - Environment Variables: en/reference/environment-variables.md
      - Credential Guide: en/reference/credential-guide.md
      - Error Codes: en/reference/error-codes.md
      - Troubleshooting: en/reference/troubleshooting.md
      - Development Guide: en/reference/development-guide.md


extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY