napari_lattice/mkdocs.yml at master · BioimageAnalysisCoreWEHI/napari_lattice · 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
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
site_name: napari_lattice

markdown_extensions:
- mkdocs-click
- pymdownx.highlight:
    anchor_linenums: true
- pymdownx.superfences
- admonition
- pymdownx.details
- attr_list
- md_in_html
- pymdownx.blocks.caption
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
- "Home": index.md
- "Installation": installation.md
- "Napari Plugin":
  - "Overview": napari_plugin/index.md
  - "Initializing the Plugin": napari_plugin/starting_plugin.md
  - "Using the Plugin": napari_plugin/plugin_usage.md
- "Command Line": cli.md
- "Python API": api.md
- "Workflows":
  - "Overview": workflows/index.md
  - "Running a Workflow": workflows/programmatic_workflow.md
  - "Interactive (napari-assistant)": workflows/interactive_workflow.md
  - "Notebook: Simple": 'workflows/notebooks/Image_analysis_workflow_simple.ipynb'
  - "Notebook: Advanced": 'workflows/notebooks/Image_analysis_workflow_advanced.ipynb'
- "Examples":
  - "Overview": examples/index.md
  - "Oblique Plane Microscopy (OPM)": examples/opm.md
  - "MIPs and defining ROIs": examples/mips.md
  - "Neutrophil (end-to-end)": examples/neutrophil.md
  - "HPC with SLURM": examples/hpc_slurm.md
- "Development": development.md
- "Supporting Resources":
  - "Overview": miscellaneous/index.md
  - "Defining ROIs for cropping": miscellaneous/rois_cropping.md
  - "Output metadata": miscellaneous/output_metadata.md
plugins:
- search
- mkdocs-video:
    is_video: True
    video_muted: True
    video_controls: True
    css_style:
      width: "75%"
- mkdocs-jupyter
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        options:
          heading_level: 3
          show_root_heading: true
          # Inheritance and source are useful for advanced users,
          # but possibly confusing for others
          show_bases: false
          show_source: false
          show_signature_annotations: true
          separate_signature: true
          signature_crossrefs: true
          extensions:
          - griffe_fieldz:
              include_inherited: true

theme:
  name: material
  features:
    - content.code.copy
    - content.tabs.link
    - navigation.tabs #tabs on top
    - navigation.tabs.sticky #visible even when scrolling down
    - navigation.sections
  palette:
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

# Google analytics
extra:
  analytics:
    provider: google
    property: G-S3Y319X195