-
Notifications
You must be signed in to change notification settings - Fork 14
/
mkdocs.yml
211 lines (199 loc) · 6.54 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
# Project information
site_name: TrioDocs
site_description: Documentation of Trio, an Automated Insulin Delivery system for iOS.
site_url: https://docs.diy-trio.org/
site_author: Trio Community
use_directory_urls: true
# GitHub Repository
repo_name: nightscout/trio-docs
repo_url: https://github.com/nightscout/trio-docs/
edit_uri: edit/dev/docs/
copyright: Trio Community
theme:
name: material
language: en
custom_dir: overrides
logo: assets/images/trio-logo.png
favicon: assets/images/favicon.ico
icon:
repo: fontawesome/brands/github
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: deep purple
accent: light blue
toggle:
icon: material/weather-sunny
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: light blue
toggle:
icon: material/weather-night
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: light blue
toggle:
icon: material/brightness-auto
name: Switch to auto (use System Preferences)
features:
- announce.dismiss
- content.action.edit
- content.code.copy
- content.tabs.link
- navigation.footer
- navigation.instant
- navigation.instant.progress
- navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.suggest
- search.highlight
- toc.follow
plugins:
- open-in-new-tab
- macros:
include_dir: .
- exporter:
formats:
pdf:
enabled: !ENV [MKDOCS_EXPORTER_PDF, false]
concurrency: 16
stylesheets:
- docs/assets/stylesheets/pdf.scss
covers:
front: docs/assets/templates/covers/front.html.j2
# back: docs/assets/templates/covers/back.html.j2
aggregator:
enabled: true
output: trio-docs.pdf
covers: limits
buttons:
- title: Download Page as PDF
icon: material-file-download-outline
enabled: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.enabled
attributes: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.attributes
- search
extra_css:
- assets/stylesheets/primary_color.css
- assets/stylesheets/extra.css
extra_javascript:
- assets/javascripts/mathjax.js
- assets/javascripts/mkdocs-exporter.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
- https://cdnjs.cloudflare.com/ajax/libs/mermaid/10.9.1/mermaid.min.js
# Customizations
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/nightscout/trio-docs
name: Trio on GitHub
- icon: fontawesome/brands/discord
link: https://discord.gg/FnwFEFUwXE
name: Trio on Discord
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/groups/diytrio
name: Trio on Facebook
version: 0.2.1
markdown_extensions:
- admonition
- attr_list
- def_list
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- tables
- toc:
permalink: true
permalink_title: Link to this section for reference
title: On this Page
toc_depth: 3
validation:
nav:
omitted_files: info
not_found: warn
absolute_links: info
links:
not_found: warn
absolute_links: info
unrecognized_links: info
not_in_nav: |
Analyze/EvaluateBasal.md
Analyze/EvaluateCR.md
Getting-Started/cgm.md
settings/loop.md
settings/configuration/preferences/statistics.md
settings/devices/pump.md
# Navigation (Page tree)
nav:
- Home: ./index.md
- Overview:
- Introduction: ./Getting-Started/Overview.md
- App Overview: ./operate/interface.md
- New User Guide: ./Setup/New-User-Setup.md
- Coming from Other AID Systems: ./Configuration/transition-qa.md
- Common Issues: ./operate/troubleshoot.md
- Device Compatibility:
- iPhones & Watches: ./Getting-Started/iphone.md
- Pumps: ./Getting-Started/pump.md
- CGMs: ./settings/devices/cgm.md
- Build/Update Trio:
- Build Instructions: ./operate/build.md
- Customizations: ./operate/customize.md
- User Settings:
- Trio Main Preferences: ./settings/configuration/preferences/trio.md
- Pump, CGM, Watch: ./Configuration/Devices.md
- Additional Pump Settings: ./settings/configuration/pumpsettings.md
- Basal: ./settings/configuration/basalprofile.md
- ISF: ./settings/configuration/insulinsensitivities.md
- CR: ./settings/configuration/carbratios.md
- Target Glucose: ./settings/configuration/targetglucose.md
- Main Settings: ./settings/configuration/preferences/mainsettings.md
- SMB & UAM: ./settings/configuration/concepts/smb-uam.md
- Close the Loop: ./Configuration/Configure.md
- Optional Settings:
- Apple Health: ./settings/services/applehealth.md
- FPU: ./settings/services/fatprotein.md
- Nightscout: ./settings/services/nightscout.md
- Notifications: ./settings/services/notifications.md
- SMB Settings: ./settings/configuration/preferences/smbsettings.md
- Temp Targets: ./operate/temptarget.md
- Advanced Settings:
- Autotune: ./settings/configuration/autotune.md
- Dynamic Settings: ./settings/configuration/concepts/autosens-dynamic.md
- Sigmoid: ./settings/configuration/concepts/sigmoid.md
- Dynamic Settings Explained: ./settings/configuration/preferences/dynamicsettings.md
- Other Settings: ./settings/configuration/preferences/othersettings.md
- Sensitivity Settings: ./settings/configuration/preferences/targetsettings.md
- Resources:
- Citations: ./resources/citations.md
- Translation: ./resources/translate.md
- TrioDocs PDF: ./trio-docs.pdf