-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
122 lines (120 loc) · 3.32 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
site_name: hydrolib-core documentation
theme:
name: material
language: en
logo: images/HYDROLIB_logo_notext_mono_eroded.svg
custom_dir: docs/overrides
palette:
- scheme: deltares
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/lightbulb
name: Switch to light mode
features:
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
plugins:
- search
- mkdocs-jupyter
- autorefs
- table-reader
- macros:
module_name: docs/include/mkdocs-macros/main
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_root_toc_entry: false
show_source: true
show_signature_annotations: true
heading_level: 3
show_category_heading: false
group_by_category: false
selection:
inherited_members: false
custom_templates: templates
watch:
- hydrolib/core
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- admonition
- toc:
permalink: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
repo_url: https://github.com/Deltares/hydrolib-core
repo_name: deltares/hydrolib-core
edit_uri: edit/main/docs/
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/github
link: https://github.com/Deltares/hydrolib-core
name: Source code
- icon: fontawesome/brands/gitter
link: https://gitter.im/Deltares/hydrolib
name: Chat with us on Gitter
copyright: Copyright © 2022 Deltares
extra_css:
- stylesheets/extra.css
nav:
- Home: "index.md"
- How-to:
- Installation:
- "pip install": "guides/setup.md"
- "Developer container": "guides/devcontainers.md"
- "Local clone + Poetry": "guides/poetry.md"
- Contributing:
- "guides/contributing.md"
- Documentation:
- "guides/documentation.md"
- Support:
- guides/gettinghelp.md
- Tutorials:
- tutorials/tutorials.md
- tutorials/build_basic_model.ipynb
- tutorials/loading_and_saving_a_model.md
- tutorials/dataframe_handling.md
- tutorials/plotting_a_network.md
- Topics:
- topics/dhydro_support.md
- topics/principles.md
- topics/pydantic.md
- topics/loadsave.md
- API Reference:
- Introduction:
- reference/glossary.md
- reference/api.md
- reference/ini.md
- DIMR:
- reference/dimr.md
- D-Flow FM:
- reference/mdu.md
- reference/net.md
- reference/ext.md
- reference/forcing.md
- reference/structure.md
- reference/friction.md
- reference/crosssection.md
- reference/storagenode.md
- reference/inifield.md
- reference/onedfield.md
- reference/polyfile.md
- reference/xyz.md
- reference/observationpoint.md
- reference/observationcrosssection.md
- RainfallRunoff:
- reference/rr/rr.md
- reference/rr/meteo.md
- Release notes: "releasenotes.md"