forked from chromatix-team/chromatix
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
72 lines (67 loc) · 1.83 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
site_name: Chromatix
repo_url: https://github.com/chromatix-team/chromatix/
nav:
- Home: index.md
- Getting started:
- Installing: installing.md
- Chromatix 101: 101.ipynb
- Polarization: polarization.ipynb
- Parallelism: parallelism.md
- Training: training.ipynb
- Higher Rank Fields: higher_rank.ipynb
- FAQ: FAQ.md
- Examples:
- Holoscope: examples/holoscope.ipynb
- Computer Generated Holography: examples/cgh.ipynb
- Digital Micromirror Device: examples/dmd.ipynb
- Fourier Ptychography: examples/fourier_ptychography.md
- Synchrotron X-ray Holography: examples/tomography.md
- Seidel Aberration Fitting: examples/seidel_fitting.ipynb
- Zernike Aberration Fitting: examples/zernike_fitting.ipynb
- API:
- Field: api/field.md
- Functional: api/functional.md
- Elements: api/elements.md
- Systems: api/systems.md
- Operations: api/ops.md
- Utilities: api/utils.md
theme:
logo: media/logo_symbol_white.png
favicon: media/favicon.png
name: material
palette:
# Palette toggle for light mode
- scheme: default
primary: deep purple
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- navigation.sections
- content.code.copy
plugins:
- mkdocstrings:
handlers:
python:
paths: [src]
options:
heading_level: 3
show_root_toc_entry: false
- mkdocs-jupyter
- search:
separator: '[\s\-\.]+'
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- admonition
- pymdownx.details
extra_css:
- css/mkdocstrings.css