-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
112 lines (103 loc) · 2.92 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
site_name: OpenTerrace Documentation
site_author: Jakob Hærvig
site_description: >-
OpenTerrace Documentation
repo_url: https://github.com/OpenTerrace/openterrace-python
edit_uri: blob/main/docs/
repo_name: openterrace-python/
theme:
name: material
icon:
repo: fontawesome/brands/github
features:
- search.highlight
- search.share
- search.suggest
- navigation.tabs
- navigation.tabs.sticky
- navigation.indexes
- navigation.tracking
- toc.integrate
palette:
scheme: default
primary: green
custom_dir: docs/overrides
logo: _figures/logo-text-icon.svg
favicon: _figures/stone.png
extra_css:
- stylesheets/extra.css
markdown_extensions:
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- admonition
- pymdownx.details
- pymdownx.superfences
- markdown_katex:
no_inline_svg: True
insert_fonts_css: True
- toc:
toc_depth: 4
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra:
generator: false
plugins:
- search
- autorefs
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [openterrace] # search packages in the src folder
setup_commands:
- import sys
- sys.path.append('openterrace')
nav:
- index.md
- Installation guide: installation.md
- Tutorials:
- tutorials/tutorial_1.md
- tutorials/tutorial_2.md
- tutorials/tutorial_3.md
- tutorials/tutorial_4.md
- tutorials/tutorial_5.md
- tutorials/tutorial_6.md
- tutorials/tutorial_7.md
- User guide:
- user-guide/getting-started.md
- Theory: theory.md
- Substances:
- Fluid:
- user-guide/fluid_substances/air.md
- user-guide/fluid_substances/water.md
- user-guide/fluid_substances/nak2278.md
- Bed:
- user-guide/bed_substances/swedish_diabase.md
- user-guide/bed_substances/magnetite.md
- user-guide/bed_substances/ATS50.md
- user-guide/bed_substances/ATS58.md
- Domain types:
- user-guide/domains/cylinder_1d.md
- user-guide/domains/block_1d.md
- user-guide/domains/sphere_1d.md
- user-guide/domains/hollow_sphere_1d.md
- user-guide/domains/lumped.md
- Numerical schemes:
- Diffusion:
- user-guide/diffusion_schemes/central_difference_1d.md
- Convection:
- user-guide/convection_schemes/upwind_1d.md
- Verification studies: user-guide/verification-and-validation/verification.md
- Validation studies: user-guide/verification-and-validation/validation.md
- source_code.md
- Citing OpenTerrace: citing.md
- Contributing and contact:
- contributing.md
- contact.md