-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
81 lines (74 loc) · 1.75 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
site_name: MDFTS
site_description: "Interface for integrated particle and field simulations"
site_url: "https://equalapriori.github.io/mdfts/"
repo_url: "https://github.com/EqualAPriori/mdfts"
repo_name: "mdfts"
site_dir: "site"
theme:
name: material
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.sections
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: lime
toggle:
icon: material/weather-night
name: Switch to light mode
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- pymdownx.mark
- pymdownx.highlight
- pymdownx.inlinehilite
- toc:
toc_depth: 3
# Other potential extensions:
# - data
# - latex
# - many more: https://squidfunk.github.io/mkdocs-material/reference/lists/#using-definition-lists
plugins:
- mkdocs-jupyter
- search
- gen-files:
scripts:
- docs/gen_ref_nav.py
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
default_handler: python
handlers:
python:
setup_commands:
- import sys
- sys.path.append("docs")
selection:
new_path_syntax: yes
rendering:
show_source: true
watch:
- src/mdfts
nav:
- "Home":
- index.md
- "Formats":
- format_ff.md
- "Code Reference":
- "At a glance": reference/ToC.md
- "Src": reference/
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/EqualAPriori/mdfts