-
Notifications
You must be signed in to change notification settings - Fork 101
/
mkdocs.yml
86 lines (80 loc) · 2.28 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
site_name: hydro-model-xaj
site_description: Hydromodel is a python implementation for common hydrological models such as the XinAnJiang (XAJ) model, which is one of the most famous conceptual hydrological models, especially in Southern China.
site_author: OuyangWenyu
site_url: https://OuyangWenyu.github.io/hydro-model-xaj
repo_url: https://github.com/OuyangWenyu/hydro-model-xaj
copyright: "Copyright © 2023 - 2023 Wenyu Ouyang"
theme:
palette:
- scheme: default
# primary: blue
# accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to light mode
name: material
icon:
repo: fontawesome/brands/github
# logo: assets/logo.png
# favicon: assets/favicon.png
features:
- navigation.instant
- navigation.tracking
- navigation.top
- search.highlight
- search.share
custom_dir: "docs/overrides"
font:
text: Google Sans
code: Regular
plugins:
- search
- mkdocstrings
- git-revision-date
- git-revision-date-localized:
enable_creation_date: true
type: timeago
# - pdf-export
- mkdocs-jupyter:
include_source: True
ignore_h1_titles: True
execute: True
allow_errors: false
ignore: ["conf.py"]
execute_ignore: ["*ignore.ipynb"]
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- pymdownx.superfences
- pymdownx.highlight:
linenums: true
- toc:
permalink: true
# extra:
# analytics:
# provider: google
# property: UA-XXXXXXXXX-X
nav:
- Home: index.md
- Installation: installation.md
- Usage: usage.md
- Contributing: contributing.md
- FAQ: faq.md
- Changelog: changelog.md
- Report Issues: https://github.com/OuyangWenyu/hydro-model-xaj/issues
- Examples:
- examples/intro.ipynb
- API Reference:
- hydromodel module: hydromodel.md
- common module: common.md