-
Notifications
You must be signed in to change notification settings - Fork 10
/
mkdocs.yml
52 lines (45 loc) · 1.15 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
site_name: torchhydro
site_url: https://OuyangWenyu.github.io/torchhydro
repo_url: https://github.com/OuyangWenyu/torchhydro
theme:
palette:
scheme: preference
name: material
icon:
repo: fontawesome/brands/github
features:
- navigation.instant
- search.highlight
# - navigation.expand
# - navigation.tabs
custom_dir: "docs/overrides"
plugins:
- search
- mkdocstrings
- git-revision-date
- mkdocs-jupyter:
include_source: True
# ignore_h1_titles: True
# execute: True
# execute_ignore: "*.ipynb"
markdown_extensions:
- attr_list
- 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/torchhydro/issues
- API Reference:
- torchhydro module: torchhydro.md