PtyLabX/mkdocs.yml at main · PtyLab/PtyLabX · GitHub

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
site_name: PtyLabX
site_description: JAX-based ptychographic reconstruction toolbox
repo_url: https://github.com/ShantanuKodgirwar/PtyLabX
repo_name: ShantanuKodgirwar/PtyLabX
dev_addr: '127.0.0.1:8000'

theme:
  name: material
  logo: assets/ptylab_logo.svg
  favicon: assets/ptylab_logo.svg
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - toc.integrate

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - CPM Workflow:
    - Overview: cpm/overview.md
    - Data Format: cpm/data-format.md
    - Engines: cpm/engines.md
    - Configuration Reference: cpm/configuration.md
  - Tutorials:
    - CPM Synthetic: tutorials/01_tutorial_CPM_synthetic.ipynb
    - CPM Example: tutorials/02_tutorial_CPM_example_data.ipynb
    - CPM Multi-Wavelength : tutorials/03_tutorial_CPM_multiWavelength.ipynb
    - CPM Position Correction: tutorials/04_tutorial_CPM_LateralPositionCorrection.ipynb
    - CPM Reflection: tutorials/05_tutorial_CPM_reflection.ipynb
    - CPM Reflection with Intensity Constraint: tutorials/06_tutorial_CPM_reflection_with_interferometricIntensityConstraint.ipynb
    - FPM Example: tutorials/07_tutorial_FPM.ipynb

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - mkdocs-jupyter:
      include: ["*.ipynb"]
      execute: false
      allow_errors: true