/
mkdocs.yml
250 lines (233 loc) · 7.35 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
###########################
# Project information #
###########################
site_name: FLEE
# site_url: https://flee.readthedocs.io
site_description: Simulation toolkit for the movement of individuals
##################
# Repository #
##################
repo_name: djgroen/flee
repo_url: https://github.com/djgroen/flee
site_author: Hamid Arabnejad
docs_dir: docs/
# Copyright
copyright: Derek Groen
####################
# Social Media #
####################
extra:
social:
# - icon: fontawesome/solid/home
# link: https://up42.com
- icon: fontawesome/brands/github-alt
link: https://github.com/djgroen/flee
# - icon: fontawesome/brands/docker
# link: https://hub.docker.com/u/up42
- icon: fontawesome/solid/envelope
link: mailto:djgroen@gmail.com
#####################
# Configuration #
#####################
theme:
name: material
# 404 page
custom_dir: docs/static/theme/overrides
static_templates:
- 404.html
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
# palette:
# # primary: indigo
# # accent: indigo
# primary: "blue grey"
# accent: "blue"
# # scheme: preference
font:
text: Roboto
code: Roboto Mono
# palette:
# # primary: blue grey
# # accent: red
# - scheme: default
# toggle:
# icon: material/weather-sunny
# name: Switch to dark mode
# # primary: teal
# # accent: red
# - scheme: slate
# toggle:
# icon: material/weather-night
# name: Switch to light mode
# # primary: teal
# # accent: red
features:
- search.suggest
- search.highlight
- navigation.tabs
- navigation.expand
favicon: images/logo/logo.png # browser tab icon
logo: images/empty.png
icon:
repo: fontawesome/brands/github
###############
# Plugins #
###############
plugins:
- search
# - enumerate-headings:
- autolinks
- awesome-pages:
collapse_single_pages: true
strict: true
- macros
- mkdocstrings:
default_handler: python
handlers:
python:
setup_commands:
- import sys
- sys.path.append("flee")
#- sys.path.insert(0, "flee")
# - sys.path.append('../')
options:
show_root_toc_entry: false
show_root_heading: false
show_root_full_path: true
show_object_full_path: false
show_source: true
show_category_heading: true
show_if_no_docstring: false
group_by_category: true
heading_level: 2
# new_path_syntax: True
filters:
- "!^_" # exlude all members starting with _
members: true
inherited_members: True
docstring_style: google
docstring_options:
replace_admonitions: false
- mermaid2:
arguments:
securityLevel: 'loose'
theme: 'forest'
#################
# Extra CSS #
#################
extra_css:
- static/css/custom.css
################
# Extra JS #
################
# source https://gokumohandas.github.io/MLOps/tagifai/data/#tagifai.data
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- https://unpkg.com/mermaid/dist/mermaid.min.js
- static/js/extra.js
##################
# Extensions #
##################
markdown_extensions:
# - admonition
- markdown.extensions.admonition # alerts
# - attr_list
- markdown.extensions.attr_list # add HTML and CSS to Markdown elements
# - def_list
- markdown.extensions.def_list
# - footnotes
- markdown.extensions.footnotes
# - meta
- markdown.extensions.meta
# - toc:
# toc_depth: 4
- markdown.extensions.toc:
baselevel: 1
permalink: true
toc_depth: 4
- pymdownx.arithmatex: # mathjax
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details # collapsible alerts
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
use_pygments: true
- pymdownx.escapeall:
nbsp: true
- pymdownx.inlinehilite # inline code highlights
- pymdownx.keys # show keystroke symbols
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets: # insert content from other files
check_paths: true
- pymdownx.superfences: # nest code and content inside alerts
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
- pymdownx.tabbed # content tabs
- pymdownx.tasklist:
custom_checkbox: true
clickable_checkbox: true
- pymdownx.tilde
- pymdownx.tabbed
- codehilite:
guess_lang: False
use_pygments: True
noclasses: True
pygments_style: monokai
- toc:
permalink: true
#################
# Page tree #
#################
nav:
- Basic:
- Introduction: index.md
- Installation and Testing: Installation_and_Testing.md
- Simulation instance construction: Simulation_instance_construction.md
- Types of location graphs: Types_of_location_graphs.md
- Simulation settings configuration (basic): Simulation_settings_basic.md
- Simulation instance execution : Simulation_instance_execution.md
- "FabFlee: Automated Flee-based simulation": FabFlee_Automated_Flee_based_simulation.md
- Input File Generation: Input_File_generator.md
- Remote execution on a supercomputer : Remote_execution_on_a_supercomputer.md
- Literature / cite us : Flee_Literature.md
- Advanced:
- Multiscale Simulation instance construction : Multiscale_Simulation_instance_construction.md
- Simulation settings configuration (advanced): Simulation_settings_advanced.md
- Sensitivity analysis of parameters using EasyVVUQ : Sensitivity_analysis_of_parameters_using_EasyVVUQ.md
- Code Reference:
- FLEE:
- Person: code_reference/flee/person.md
- Location: code_reference/flee/location.md
- Link: code_reference/flee/link.md
- Ecosystem: code_reference/flee/ecosystem.md
- Diagnostics: code_reference/flee/diagnostics.md
- InputGeography: code_reference/flee/inputGeography.md
- P-FLEE:
- Person: code_reference/pflee/person.md
- Location: code_reference/pflee/location.md
- Link: code_reference/pflee/link.md
- Ecosystem: code_reference/pflee/ecosystem.md
- multiscale-FLEE:
- CouplingInterface: code_reference/multiscale/coupling.md
- pmicro-FLEE:
- Person: code_reference/multiscale/pmicro_flee/person.md
- Location: code_reference/multiscale/pmicro_flee/location.md
- Link: code_reference/multiscale/pmicro_flee/link.md
- Link Weather Coupling : code_reference/multiscale/pmicro_flee/link_weather_coupling.md
- Ecosystem: code_reference/multiscale/pmicro_flee/ecosystem.md
- InputGeography: code_reference/multiscale/pmicro_flee/inputGeography.md
- Contributing: contributing.md
- Credits : credits.md
- Publications: papers/papers.md