forked from nautobot/nautobot-app-chatops
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
144 lines (138 loc) · 4.69 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
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
---
dev_addr: "127.0.0.1:8001"
edit_uri: "edit/develop/docs"
site_dir: "nautobot_chatops/static/nautobot_chatops/docs"
site_name: "Nautobot ChatOps Documentation"
site_url: "https://docs.nautobot.com/projects/chatops/en/stable/"
repo_url: "https://github.com/nautobot/nautobot-plugin-chatops"
copyright: "Copyright © 2020 Network to Code"
theme:
name: "material"
navigation_depth: 4
custom_dir: "docs/assets/overrides"
hljs_languages:
- "django"
- "yaml"
features:
- "navigation.tracking"
- "navigation.tabs"
- "navigation.tabs.sticky"
- "search.suggest"
- "search.highlight"
- "search.share"
- "navigation.indexes"
favicon: "assets/favicon.ico"
logo: "assets/nautobot_logo.svg"
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: "default"
primary: "black"
toggle:
icon: "material/weather-sunny"
name: "Switch to dark mode"
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: "slate"
primary: "black"
toggle:
icon: "material/weather-night"
name: "Switch to light mode"
extra_css:
- "assets/extra.css"
# needed for RTD version flyout menu
# jquery is not (yet) injected by RTD automatically and it might be dropped
# as a dependency in the future
extra_javascript:
- "https://code.jquery.com/jquery-3.6.0.min.js"
extra:
generator: false
ntc_sponsor: true
social:
- icon: "fontawesome/solid/rss"
link: "https://blog.networktocode.com/blog/tags/nautobot"
name: "Network to Code Blog"
- icon: "fontawesome/brands/youtube"
link: "https://www.youtube.com/playlist?list=PLjA0bhxgryJ2Ts4GJMDA-tPzVWEncv4pb"
name: "Nautobot Videos"
- icon: "fontawesome/brands/slack"
link: "https://www.networktocode.com/community/"
name: "Network to Code Community"
- icon: "fontawesome/brands/github"
link: "https://github.com/nautobot/nautobot"
name: "GitHub Repo"
- icon: "fontawesome/brands/twitter"
link: "https://twitter.com/networktocode"
name: "Network to Code Twitter"
markdown_extensions:
- "admonition"
- "toc":
permalink: true
- "attr_list"
- "md_in_html"
- "pymdownx.highlight":
anchor_linenums: true
- "pymdownx.inlinehilite"
- "pymdownx.snippets"
- "pymdownx.superfences"
plugins:
- "search"
- "include-markdown"
- "mkdocs-version-annotations"
- mkdocstrings:
default_handler: "python"
handlers:
python:
paths: ["."]
options:
show_root_heading: true
watch:
- "README.md"
nav:
- Overview: "index.md"
- User Guide:
- App Overview: "user/app_overview.md"
- Getting Started: "user/app_getting_started.md"
- Frequently Asked Questions: "user/app_faq.md"
- Administrator Guide:
- Install and Configure:
- "admin/install/index.md"
- "admin/install/slack_setup.md"
- "admin/install/mattermost_setup.md"
- "admin/install/webex_setup.md"
- "admin/install/microsoft_teams_setup.md"
- Upgrade: "admin/admin_upgrade.md"
- Uninstall: "admin/admin_uninstall.md"
- Compatibility Matrix: "admin/compatibility_matrix.md"
- Release Notes:
- "admin/release_notes/index.md"
- v1.11: "admin/release_notes/version_1.11.md"
- v1.10: "admin/release_notes/version_1.10.md"
- v1.9: "admin/release_notes/version_1.9.md"
- v1.8: "admin/release_notes/version_1.8.md"
- v1.7: "admin/release_notes/version_1.7.md"
- v1.6: "admin/release_notes/version_1.6.md"
- v1.5: "admin/release_notes/version_1.5.md"
- v1.4: "admin/release_notes/version_1.4.md"
- v1.3: "admin/release_notes/version_1.3.md"
- v1.2: "admin/release_notes/version_1.2.md"
- v1.1: "admin/release_notes/version_1.1.md"
- Developer Guide:
- Extending the App: "dev/dev_extending.md"
- Contributing to the App: "dev/dev_contributing.md"
- Design Documentation: "dev/design.md"
- Development Environment: "dev/dev_environment.md"
- Release Checklist: "dev/release_checklist.md"
- Code Reference:
- "dev/code_reference/index.md"
- Models: "dev/code_reference/models.md"
- API: "dev/code_reference/api.md"
- Dispatchers:
- "dev/code_reference/base.md"
- "dev/code_reference/slack.md"
- "dev/code_reference/webex.md"
- "dev/code_reference/ms_teams.md"
- "dev/code_reference/mattermost.md"
- "models/accessgrant.md"
- "models/commandtoken.md"
- Nautobot Docs Home ↗︎: "https://docs.nautobot.com"