-
Notifications
You must be signed in to change notification settings - Fork 297
/
mkdocs.yml
216 lines (185 loc) · 7.31 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: 'WeeWX 5.0'
site_url: 'https://www.weewx.com'
site_author: "Tom Keffer <tkeffer@gmail.com>"
# do not display github info since it is always obscured anyway
#repo_url: https://github.com/weewx/weewx
#repo_name: WeeWX GitHub Repository
# Shut off the "edit on GitHub" feature:
edit_uri: ''
copyright: Copyright © 2009-2023 Thomas Keffer, Matthew Wall, and Gary Roderick, all rights reserved
theme:
name: 'material'
logo: 'images/logo-weewx.png'
favicon: 'images/favicon.png'
features:
- navigation.instant
- navigation.tracking
- navigation.indexes
- navigation.top
- toc.follow
- search.highlight
- search.share
- search.suggest
- content.tabs.link
font:
text: 'Noto Sans'
code: 'Inconsolata Mono'
palette:
- scheme: default
primary: teal
accent: white
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: teal
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to light mode
extra_css:
- css/weewx_ui.css
docs_dir: 'docs_src'
site_dir: 'build/docs'
nav:
- "Overview" : index.md
- "Quick start":
- Debian: quickstarts/debian.md
- RedHat: quickstarts/redhat.md
- SuSE: quickstarts/suse.md
- pip: quickstarts/pip.md
- git: quickstarts/git.md
- "User's guide":
- "Introduction": usersguide/introduction.md
- "Installing WeeWX": usersguide/installing.md
- "Where to find things" : usersguide/where.md
- "Running WeeWX": usersguide/running.md
- "Web server integration": usersguide/webserver.md
- "Backup & restore": usersguide/backup.md
- "MySQL/MariaDB": usersguide/mysql-mariadb.md
- "Troubleshooting":
- "What to do": usersguide/troubleshooting/what-to-do.md
- "Hardware problems": usersguide/troubleshooting/hardware.md
- "Software problems": usersguide/troubleshooting/software.md
- "Meteorological problems": usersguide/troubleshooting/meteo.md
- Customization guide:
- "Introduction": custom/introduction.md
- "Customizing reports": custom/custom-reports.md
- "Scheduling reports": custom/report-scheduling.md
- "The Cheetah generator": custom/cheetah-generator.md
- "The Image generator": custom/image-generator.md
- "Localization": custom/localization.md
- "Customizing the database": custom/database.md
- "Customizing units": custom/units.md
- "Multiple data bindings": custom/multiple-bindings.md
- "Search lists": custom/sle.md
- "Services": custom/service-engine.md
- "Derived types": custom/derived.md
- "Drivers": custom/drivers.md
- "Extensions": custom/extensions.md
- Utilities guide:
- weewxd: utilities/weewxd.md
- weectl:
- weectl: utilities/weectl-about.md
- weectl database: utilities/weectl-database.md
- weectl debug: utilities/weectl-debug.md
- weectl device: utilities/weectl-device.md
- weectl extension: utilities/weectl-extension.md
- weectl station: utilities/weectl-station.md
- wee_import: utilities/wee_import.md
- wee_reports: utilities/wee_reports.md
- "Hardware guide":
- Drivers: hardware/drivers.md
- AcuRite: hardware/acurite.md
- CC3000: hardware/cc3000.md
- FineOffset: hardware/fousb.md
- TE923: hardware/te923.md
- Ultimeter: hardware/ultimeter.md
- Vantage: hardware/vantage.md
- WMR100: hardware/wmr100.md
- WMR300: hardware/wmr300.md
- WMR9x8: hardware/wmr9x8.md
- WS1: hardware/ws1.md
- WS23xx: hardware/ws23xx.md
- WS28xx: hardware/ws28xx.md
- "Upgrade guide": upgrade.md
- Reference:
- "Application options":
- "Introduction": reference/weewx-options/introduction.md
- "General options": reference/weewx-options/general.md
- "[Station]": reference/weewx-options/stations.md
- "[StdRESTful]": reference/weewx-options/stdrestful.md
- "[StdReport]": reference/weewx-options/stdreport.md
- "[StdConvert]": reference/weewx-options/stdconvert.md
- "[StdCalibrate]": reference/weewx-options/stdcalibrate.md
- "[StdQC]": reference/weewx-options/stdqc.md
- "[StdWXCalculate]": reference/weewx-options/stdwxcalculate.md
- "[StdArchive]": reference/weewx-options/stdarchive.md
- "[StdTimeSynch]": reference/weewx-options/stdtimesynch.md
- "[DataBindings]": reference/weewx-options/data-bindings.md
- "[Databases]": reference/weewx-options/databases.md
- "[DatabaseTypes]": reference/weewx-options/database-types.md
- "[Engine]": reference/weewx-options/engine.md
- "Skin options":
- "Introduction": reference/skin-options/introduction.md
- "[Extras]": reference/skin-options/extras.md
- "[Labels]": reference/skin-options/labels.md
- "[Almanac]": reference/skin-options/almanac.md
- "[Units]": reference/skin-options/units.md
- "[Texts]": reference/skin-options/texts.md
- "[CheetahGenerator]": reference/skin-options/cheetahgenerator.md
- "[ImageGenerator]": reference/skin-options/imagegenerator.md
- "[CopyGenerator]": reference/skin-options/copygenerator.md
- "[Generators]": reference/skin-options/generators.md
- "Aggregation types": reference/aggtypes.md
- "Durations": reference/durations.md
- "Units": reference/units.md
- "ValueTuple": reference/valuetuple.md
- "ValueHelper": reference/valuehelper.md
- "Notes for developers": devnotes.md
- "Change log": changes.md
plugins:
- search
markdown_extensions:
# Code highlighting in ``` ``` blocks
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details
- pymdownx.details
# linkifies URL and email links without having to wrap them in Markdown syntax. Also, allows shortens repository issue, pull request, and commit links.
- pymdownx.magiclink
# Highlight words with ==mark me==
- pymdownx.mark
# Adds support for strike through ~~strike me~~ and subscript text~a\ subscript~
- pymdownx.tilde
# Tabbed provides a syntax to easily add tabbed Markdown content.
# https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets:
# auto_append abbreviations.md to every file
# https://squidfunk.github.io/mkdocs-material/reference/tooltips/#adding-a-glossary
auto_append:
- docs/abbreviations.md
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# Adds the ability to define abbreviations (https://squidfunk.github.io/mkdocs-material/reference/tooltips/)
- abbr
# block-styled side content
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/
- admonition
- attr_list
# Adds syntax for defining footnotes in Markdown documents (https://squidfunk.github.io/mkdocs-material/reference/footnotes/)
- footnotes
- md_in_html
- tables
# Table of Contents`
# https://python-markdown.github.io/extensions/toc/
- toc:
permalink: true