-
Notifications
You must be signed in to change notification settings - Fork 7
/
mkdocs.yml
executable file
·126 lines (113 loc) · 3.1 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
123
124
125
126
# Project info
site_name: JaxDF
site_author: Antonio Stanziola, Biomedical Ultrasound Group
site_description: >-
A JAX-based research framework for writing differentiable numerical simulators with arbitrary discretizations
site_url: https://ucl-bug.github.io/jaxdf/
# Github info
repo_name: ucl-bug/jaxdf
repo_url: https://github.com/ucl-bug/jaxdf
theme:
name: "material"
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
- toc.integrate
palette:
- scheme: default
primary: red
accent: red
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: red
accent: red
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
nav:
- Home: index.md
- Tutorials:
- Quick start: notebooks/quickstart.ipynb
- Physics informed neural networks: notebooks/pinn_burgers.ipynb
- Optimize acoustic simulations: notebooks/simulate_helmholtz_equation.ipynb
- How discretizations work: notebooks/api_discretization.ipynb
- Helmholtz equation with PINNs: notebooks/helmholtz_pinn.ipynb
- API:
- conv: conv.md
- core: core.md
- discretization: discretization.md
- exceptions: exceptions.md
- geometry: geometry.md
- mods: mods.md
- operators:
- differential: operators/differential.md
- functions: operators/functions.md
- linear algebra: operators/linear_algebra.md
- util: util.md
- Changelog: changelog.md
- Contributing: contributing.md
# Customization
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/ucl-bug/jaxdf
- icon: fontawesome/brands/python
link: https://pypi.org/project/jaxdf/
- icon: fontawesome/brands/twitter
link: https://twitter.com/UCL_Ultrasound
- icon: fontawesome/brands/discord
link: https://discord.gg/VtUb4fFznt
plugins:
- mkdocs-jupyter
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: false
- search
- mermaid2
- macros:
module_name: docs/macros
markdown_extensions:
- toc:
toc_depth: 5
- pymdownx.highlight
- pymdownx.snippets
- admonition
- attr_list
- footnotes
- pymdownx.details # For collapsible admonitions
- pymdownx.superfences
extra_css:
- stylesheets/extra.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
extra_javascript:
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
- https://unpkg.com/mermaid/dist/mermaid.min.js
use_directory_urls: false
# For mkdocstrings
watch:
- jaxdf