-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
executable file
·98 lines (86 loc) · 2.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
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
site_name: Holab
site_author: Antonio Stanziola, Michael Brown, Biomedical Ultrasound Group
site_description: Design of acoustic hologram lenses using differentiable wave simulation in JAX.
site_url: https://ucl-bug.github.io/holab/
# GitHub info
repo_name: ucl-bug/holab
repo_url: https://github.com/ucl-bug/holab
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
font:
text: Roboto
code: Roboto Mono
palette:
- scheme: slate
primary: red
accent: red
toggle:
icon: material/brightness-4
name: Switch to light mode
- scheme: default
primary: red
accent: red
toggle:
icon: material/brightness-7
name: Switch to dark mode
logo: assets/images/holab_logo_only.png
nav:
- Home: index.md
- Changelog: changelog.md
- Example: example.ipynb
- API Reference:
- losses: api/losses.md
- materials: api/materials.md
- objects: api/objects.md
- physics: api/physics.md
- settings: api/settings.md
- utils: api/utils.md
plugins:
- mkdocs-jupyter
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: false
- search
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
# For mkdocstrings
watch:
- holab