-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
114 lines (113 loc) · 2.86 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
site_name: FM2PROF
site_dir: documentation
theme:
name: material
custom_dir: docs
language: en
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
# - content.code.select
- content.footnote.tooltips
- content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
# - navigation.instant
# - navigation.instant.prefetch
# - navigation.instant.progress
# - navigation.prune
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
- toc.integrate
icon:
logo: material/selection-off
palette:
# Palette toggle for light mode
- scheme: deltares
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
plugins:
- search
- markdown-exec
- blog
- glightbox
- git-revision-date-localized:
enable_creation_date: true
#- git-committers:
# repository: Deltares/Fm2Prof
- mkdocstrings:
handlers:
python:
paths: [fm2prof]
options:
show_root_heading: false
show_root_toc_entry: false
allow_inspection: true
show_bases: true
heading_level: 3
inherited_members: true
merge_init_into_class: true
- mkdocs-jupyter
repo_url: https://github.com/Deltares/Fm2Prof
repo_name: deltares/fm2prof
copyright: Copyright © 2024 Deltares
extra_css:
- stylesheets/extra.css
nav:
- Home: index.md
- Changelog: CHANGELOG.md
- User Manual:
- Installation: markdown/installation.md
- Quickstart: markdown/quickstart.md
- Utilities:
- markdown/utils.md
- notebooks/cross_section_data.ipynb
- notebooks/compare1d2d.ipynb
- notebooks/VisualiseOutput.ipynb
- Settings:
- Configuration: markdown/configuration.md
- Technical Manual:
- Methodology: markdown/conceptual_design.md
- Glossary: markdown/glossary.md
- numerical methods: markdown/numerical_methods.md
- Contributing: markdown/contributing.md
markdown_extensions:
- admonition
- footnotes
- attr_list
- md_in_html
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
base_path: [docs/snippets, "."]
- pymdownx.superfences
extra:
version:
provider: mike