-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
117 lines (117 loc) · 3.53 KB
/
mkdocs.yml
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_name: Gufo SNMP
site_description: Gufo SNMP Documentation
site_author: Gufo Labs
site_url: "https://docs.gufolabs.com/gufo_snmp/"
copyright: "© 2023, Gufo Labs"
site_dir: dist/docs/
repo_url: https://github.com/gufolabs/gufo_snmp/
repo_name: gufolabs/gufo_snmp
nav:
- Home: index.md
- Installation: installation.md
- Examples:
- Overview: examples/index.md
- Sync Mode:
- Overview: examples/sync/index.md
- Single Item Get Request: examples/sync/get.md
- Multi Items Get Request: examples/sync/getmany.md
- GetNext Request: examples/sync/getnext.md
- GetBulk Request: examples/sync/getbulk.md
- Fetch: examples/sync/fetch.md
- SNMPv3 Get Request: examples/sync/get-v3.md
- SNMPv3 Engine ID Discovery: examples/sync/engine-id-discovery.md
- Rate Limiting: examples/sync/ratelimit.md
- Debugging: examples/sync/debugging.md
- Async Mode:
- Overview: examples/async/index.md
- Single Item Get Request: examples/async/get.md
- Multi Items Get Request: examples/async/getmany.md
- GetNext Request: examples/async/getnext.md
- GetBulk Request: examples/async/getbulk.md
- Fetch: examples/async/fetch.md
- SNMPv3 Get Request: examples/async/get-v3.md
- SNMPv3 Engine ID Discovery: examples/async/engine-id-discovery.md
- Rate Limiting: examples/async/ratelimit.md
- Debugging: examples/async/debugging.md
- Reference: reference/
- Developers' Guide:
- Overview: dev/index.md
- Developer's Environment: dev/environment.md
- Building and Testing: dev/testing.md
- Common Tasks: dev/common.md
- Code Quality: dev/codequality.md
- Code Base: dev/codebase.md
- Contributing Guide: dev/CONTRIBUTING.md
- Code of Conduct: dev/CODE_OF_CONDUCT.md
- Supported Standards: dev/standards.md
- Supported BER Types: dev/types.md
- Benchmarks: benchmarks.md
- FAQ: faq.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
# Users
theme:
name: material
logo: assets/logo.png
favicon: assets/logo.png
custom_dir: docs/overrides
icon:
repo: fontawesome/brands/github
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
primary: deep purple
scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- content.action.edit
- navigation.tabs
- navigation.tabs.sticky
- navigation.footer
watch:
- docs/
- src/gufo/
- examples/
plugins:
- search
- gen-files:
scripts:
- docs/gen_doc_stubs.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_source: false
show_submodules: false
markdown_extensions:
- toc:
permalink: True
- admonition
- footnotes
- pymdownx.highlight:
anchor_linenums: True
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra:
analytics:
provider: google
property: G-GW3X378HNJ