-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
234 lines (220 loc) · 6.72 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
---
site_name: FireFighter Docs
site_description: FireFighter is ManoMano's incident management tool, built on top of Slack and Jira, with Django and Python.
site_url: https://manomanotech.github.io/firefighter-incident/
repo_url: https://github.com/ManoManoTech/firefighter-incident
repo_name: ManoManoTech/firefighter-incident
edit_uri: https://github.com/ManoManoTech/firefighter-incident/edit/main/docs/
copyright: Copyright © 2021-2024 Colibri SAS
dev_addr: "127.0.0.1:9000"
site_dir: site
docs_dir: docs
watch:
- src
- docs
- mkdocs.yml
- README.md
- scripts
extra_css:
- css/style.css
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
theme:
name: "material"
custom_dir: !relative $docs_dir/overrides
logo: assets/FireFighterIcon.png
favicon: assets/FireFighterIcon.png
features:
- content.action.edit
- content.action.view
- content.code.annotate
- content.tabs.link
- navigation.expand
- navigation.instant
- navigation.instant.progress
# - navigation.indexes
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- search.highlight
- search.share
- search.suggest
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: red
accent: red
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: red
accent: red
toggle:
icon: material/weather-sunny
name: Switch to light mode
extra:
generator: false
version:
provider: mike
default:
- latest
- dev
social:
- icon: fontawesome/brands/github
link: https://github.com/ManoManoTech/firefighter-incident
- icon: fontawesome/brands/python
link: https://pypi.org/project/firefighter-incident/
nav:
- Home:
- Home: index.md
- Roadmap: roadmap.md
- Changelog: CHANGELOG.md
- Code of Conduct: CODE_OF_CONDUCT.md
- Credits: credits.md
- License: license.md
- FAQ: FAQ.md
- Usage:
- Integrations: usage/integrations.md
- Deployment:
- deploy/00-intro.md
- Settings:
- deploy/XX-settings.md
- deploy/XX-custom-settings.md
- deploy/XX-auth.md
- Translation and timezone: deploy/XX-i18n-l10.md
- deploy/XX-logs-traces.md
- deploy/XX-tasks.md
- deploy/XX-support-policy.md
- Development:
- contributing/0000-README.md
- Local Development:
- 0. Prerequisites: contributing/0000-prerequisites.md
- 1. Setup environment & app: contributing/0001-setup-environment.md
- 2. Configure Slack: contributing/0002-setup-slack-app.md
- Developper Guide & Tools: contributing/development.md
- Architecture & Design:
- Architecture Overview: contributing/0010-general_architecture.md
- UI Guidelines: contributing/ui.md
- UX Guidelines: contributing/ux.md
- Docs Guidelines: contributing/documentation.md
- Developper FAQ: contributing/faq.md
- Reference:
- Django Apps:
- api: reference/api.md
- confluence: reference/confluence.md
- firefighter: reference/firefighter.md
- incidents: reference/incidents.md
- pagerduty: reference/pagerduty.md
- slack: reference/slack.md
- jira_app: reference/jira_app.md
- raid: reference/raid.md
- logging: reference/logging.md
markdown_extensions:
abbr: {}
admonition: {}
attr_list: {}
codehilite: {}
def_list: {}
tables: {}
md_in_html: {}
mdx_truly_sane_lists: {}
pymdownx.magiclink: {}
pymdownx.details: {}
pymdownx.highlight:
anchor_linenums: true
pymdownx.inlinehilite: {}
pymdownx.snippets:
check_paths: true
base_path: !relative $docs_dir/..
pymdownx.tabbed:
alternate_style: true
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
pymdownx.tasklist:
custom_checkbox: true
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
toc:
permalink: "¤"
plugins:
- autorefs
- include-markdown
- git-revision-date-localized:
enabled: !ENV [CI, false]
- git-authors:
enabled: !ENV [CI, false]
- markdown-exec
- search
- section-index
- social:
enabled: !ENV [CI, false]
- mike:
canonical_version: "latest"
version_selector: true
- redirects:
redirect_maps:
contributing.md: contributing/0000-README.md
- minify:
minify_html: true
- mkdocstrings:
handlers:
python:
setup_commands:
- "import os"
- "import sys"
- "import django"
- "sys.path.insert(0, os.path.abspath('.'))"
- "sys.path.insert(0, os.path.abspath('src'))"
- "os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'firefighter.firefighter.settings')"
- "django.setup()"
import:
- https://docs.python.org/3.12/objects.inv
- https://docs.celeryq.dev/en/stable/objects.inv
# - https://slack.dev/python-slack-sdk/objects.inv
- url: https://docs.djangoproject.com/en/4.2/_objects/
base_url: https://docs.djangoproject.com/en/4.2/
domains: [std, py]
paths: [src] # search packages in the src folder
options:
docstring_options:
ignore_init_summary: true
docstring_section_style: list
filters: ["!^_"]
heading_level: 1
inherited_members: true
merge_init_into_class: true
preload_modules: [mkdocstrings]
separate_signature: true
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
summary: true
unwrap_annotated: true
# show_root_heading: true
# show_signature_annotations: true
show_if_no_docstring: false
# separate_signature: true
line_length: 140
# merge_init_into_class: true
show_submodules: true
docstring_style: google
# docstring_options:
# ignore_init_summary: true