-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathmkdocs.yml
281 lines (274 loc) · 11 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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
site_name: Smart Citizen Docs
site_description: Smart Citizen Documentation
site_author: Smart Citizen Team
site_url: https://docs.smartcitizen.me/
repo_name: smartcitizen-docs
repo_url: https://github.com/fablabbcn/smartcitizen-docs
# https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation
nav:
- Welcome!:
- Getting Started: index.md
- Introduction: introduction.md
- Hardware:
- Hardware Ecosystem: Components/index.md
- Smart Citizen Kit:
- What is it?: Smart Citizen Kit.md
- Components:
- Data Board: Components/boards/Data Board.md
- Urban Board: Components/boards/Urban Board.md
- Enclosures: Components/enclosures/Enclosures.md
- Smart Citizen Station:
- What is it?: Smart Citizen Station.md
- Components:
- Gas Pro Sensor Board: Components/boards/Gases Pro Board.md
- PM Board: Components/boards/PM Board.md
- Analog Sensor Board: Components/boards/Analog Sensor Board.md
- Soil and Water: Components/Soil and water.md
- Supported sensors: Components/Auxiliary Connector.md
- Power Supply: Components/boards/Power Supply.md
- Solar Panel: Components/Solar Panel.md
- GPS: Components/GPS.md
- Firmware:
- Architecture: Components/Firmware.md
- Flash Storage: Components/Flash Storage.md
- Sensor Knowledge:
- Performance summary: Components/sensors/performance.md
- Air:
- Particulate Matter: Components/sensors/air/PM Sensors.md
- Noise: Components/sensors/air/Noise.md
- Metal Oxide Sensors:
- What to expect: Components/sensors/air/Metal Oxide.md
- eCO2/TVOC: Components/sensors/air/CCS811.md
- Electrochemical Sensors: Components/sensors/air/Electrochemical Sensors.md
# - Air Mobile sensors: Components/sensors/air/mobile.md
- Soil:
- Soil Moisture Sensors: Components/sensors/soil/Soil Moisture Sensors.md
- Tensionmenter: Components/sensors/soil/Tensiometer.md
- FAQ: _FAQ.md
- Troubleshooting: Troubleshooting.md
- Data:
- Sensor Platform: Data/Sensor Platform.md
- Smart Citizen API: Data/Smart Citizen API.md
- Data Analysis: Data/Data Analysis.md
- Guides:
- Main: Guides/index.md
- Getting started:
- Onboarding Sensors: Guides/getting started/Onboarding Sensors.md
- Downloading platform data: Guides/getting started/Downloading the Data.md
- Uploading SD-card data: Guides/getting started/Uploading SD Card Data.md
- Updating the Wi-Fi: Guides/getting started/Updating the Wi-Fi.md
- Troubleshooting SD-Card Mode: Guides/getting started/Troubleshooting SD-card.md
- Using the Shell: Guides/getting started/Using the Shell.md
- Debugging your sensors: Guides/getting started/Debugging your kit.md
- Getting firmware information: Guides/getting started/Getting firmware information.md
- Third party sensors: Guides/getting started/Third party sensors.md
# - External Sensors: Guides/getting started/External Sensors.md
# - Dealing with sensitive sensor readings: Guides/getting started/Dealing with sensitive sensor readings.md
- Firmware:
- Update the firmware: Guides/firmware/Update the firmware.md
- Edit the firmware: Guides/firmware/Edit the Firmware.md
- Debug the firmware: Guides/firmware/Debug the firmware.md
- Calibration:
# - Air sensors: Guides/calibration/Air sensors.md
- Water sensors: Guides/calibration/Water sensors.md
- Soil sensors: Guides/calibration/Soil moisture sensors.md
- CO2 sensor: Guides/calibration/SCD30 CO2 sensor.md
- Data Analysis:
- Framework Installation: Guides/data/Install the framework.md
- Make reports of your data: Guides/data/Make reports of your data.md
- Creating interfaces: Guides/data/Creating Interfaces.md
- Organise your data: Guides/data/Organise your data.md
- Handling calibration data: Guides/data/Handling calibration data.md
- Custom data processing: Guides/data/Custom data processing.md
# - Model your sensor data: Guides/data/Creating Models for Sensors Calibration.md
# - Analyse your data in batch: Guides/Analyse your data in batch.md
- Uploading data to zenodo: Guides/data/Upload data to zenodo.md
- Deploying sensors:
- Smart Citizen Kit: Guides/deployments/Deploying SCK.md
- iSCAPE Station V1: Guides/deployments/Deploying iSCAPE Station V1.md
- iSCAPE Station V2: Guides/deployments/Deploying iSCAPE Station V2.md
- Smart Citizen Station V3: Guides/deployments/Deploying Smart Citizen Station.md
- Smart Citizen Water Station: Guides/deployments/Water sensors.md
- Mobile sensors (GPS): Guides/deployments/Almabike sensors.md
- Using Auxiliaries:
- Smart Citizen Connectivity Units: Guides/deployments/Installing Connectivity Units.md
- Smart Citizen Power Supply: Guides/deployments/Using the power supply.md
- Solar Panel: Guides/deployments/Installing solar panel.md
- OLED display: Guides/deployments/OLED display.md
- Replacements:
- Replacing PM Sensors: Guides/replacements/Replacing PM Sensors.md
- Enclosures:
- Making your own enclosures: Guides/enclosures/Making your own enclosures.md
- Assembling Smart Citizen Stations: Guides/enclosures/Assembling Smart Citizen Stations.md
- Legacy Hardware:
- Smart Citizen 1.1:
- Main: Components/legacy/index.md
- Hardware: Components/legacy/Hardware.md
- Command Line: Components/legacy/Command Line.md
- FAQ: Components/legacy/Faq.md
- Troubleshooting: Components/legacy/Troubleshooting.md
- Smart Citizen 2.0:
- Main: Components/legacy/sck.md
- About the CO-NO2 MOs: Components/sensors/air/SGX MICS.md
- Resources:
- Main: Resources/index.md
- Citizen Sensing Toolkit: Resources/Citizen Sensing Toolkit.md
- Research Projects: Resources/Research.md
- Friend projects: Resources/References.md
- Tutorials:
- Index: Resources/Tutorials/index.md
- Arduino:
- Arduino serial monitor with the SCK: Resources/Tutorials/Arduino Serial.md
- Change data rate in the SCK: Resources/Tutorials/Change data rate in the SCK.md
- Data:
- Configure Orange Data Analysis: Resources/Tutorials/Configure Orange Data Analysis.md
- Smart Citizen Orange Widgets: Guides/data/Orange Data Widgets.md
- Simple workflow for data analysis in Orange: Resources/Tutorials/Simple Orange Workflow.md
- Orange and geolocated data: Resources/Tutorials/Orange and geolocated data.md
- Education:
- Main: Resources/Education/index.md
# - Technical Modules:
# - Índice: Resources/Education/Technical Modules/index.md
# - Datos: Resources/Education/Technical Modules/Datos/index.md
- Aulamar (ES):
- Índice: Resources/Education/AulaMar/index.md
- Notas generales: Resources/Education/AulaMar/General.md
- Instrucciones: Resources/Education/AulaMar/Instrucciones.md
- Guías por métrica:
- pH: Resources/Education/AulaMar/pH.md
- Oxígeno disuelto: Resources/Education/AulaMar/OD.md
- Conductividad: Resources/Education/AulaMar/EC.md
- Temperatura: Resources/Education/AulaMar/T.md
- CLAB (EN): Resources/Education/CLAB/index.md
- Webinars:
- Main: Resources/Webinars/index.md
theme:
language: 'en'
name: 'material'
features:
- instant
# - navigation.expand
- navigation.indexes
- navigation.instant
# - navigation.prune
# - navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- content.tooltips
custom_dir: 'custom_theme'
palette:
# Palette toggle for light mode
- scheme: default
primary: blue
accent: blue
toggle:
icon: material/lightbulb
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: black
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
logo: 'assets/images/logo.svg'
favicon: 'assets/images/favicon.ico'
icon:
repo: fontawesome/brands/git-alt
extra_css:
- stylesheets/extra.css
extra:
social:
- icon: fontawesome/brands/twitter
link: 'https://twitter.com/smartcitizenkit'
- icon: fontawesome/brands/instagram
link: 'https://www.instagram.com/smartcitizenkit/'
- icon: fontawesome/brands/github
link: 'https://www.github.com/fablabbcn/smartcitizen-kit-21'
project: 'The Smart Citizen has received funding from the European Community’s H2020 and HORIZON programmes.
<br>- As part of the iSCAPE project under Grant Agreement No. 689954.
<br>- As part of MINKE project under Grant Agreement No. 101008724.
<br>- As part of TwinAIR project under Grant Agreement No. 101057779'
footer_logo: '/assets/images/eu-flag.png'
license: 'GNU Free Documentation License'
license_url: 'https://www.gnu.org/licenses/fdl-1.3.html'
fullscreen_button: true
# alternate:
# - name: English
# link: /
# lang: en
# - name: Español
# link: /es/
# lang: es
plugins:
- macros
- search
# - tags
# - with-pdf:
# author: Smart Citizen
# copyright: 'CC Attribution-NonCommercial-ShareAlike 4.0 International'
# cover: true
# cover_title: Smart Citizen Sensors Documentation
# cover_subtitle: Smart Citizen - Oct 2020
# toc_title: Table of contents
# heading_shift: false
# toc_level: 3
# ordered_chapter_level: 2
# excludes_children:
# - 'release-notes/:upgrading'
# - 'release-notes/:changelog'
# exclude_pages:
# - 'Components/'
# - 'Guides/'
# - 'Legacy Hardware/'
# - 'Sensors Analysis Framework/'
# - 'Sensor Platform/'
# convert_iframe:
# - src: IFRAME SRC
# img: POSTER IMAGE URL
# text: ALTERNATE TEXT
# - src: ...
# two_columns_level: 3
# render_js: true
# headless_chrome_path: headless-chromium
# output_path: ..
# enabled_if_env: ENABLE_PDF_EXPORT
# debug_html: true
# show_anchors: true
# verbose: true
markdown_extensions:
- md_in_html
- admonition
- codehilite
- footnotes
- toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
# - pymdownx.snippets:
# base_path: 'docs'
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- attr_list
- pymdownx.tabbed
extra_javascript:
- 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
- 'https://buttons.github.io/buttons.js'
- '/javascripts/extra.js'