cloudscope/mkdocs.yml at main · mapmanager/cloudscope · 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
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
site_name: CloudScope
site_description: Desktop and browser scientific image loading, visualization, and analysis for acquisition-backed microscopy files.
site_url: https://mapmanager.github.io/cloudscope/
repo_url: https://github.com/mapmanager/cloudscope
repo_name: mapmanager/cloudscope

theme:
  name: material
  custom_dir: docs/assets/overrides
  logo: assets/cloudscope.png
  favicon: assets/cloudscope.png
  features:
    - navigation.indexes
    - navigation.top
    - toc.follow
    - content.code.copy
    - content.tabs.link
    - search.highlight
    - search.suggest
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra_css:
  - assets/stylesheets/extra.css

hooks:
  - docs/hooks.py

plugins:
  - search
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_signature_annotations: true
            separate_signature: true
            members_order: source
            filters: ["!^_"]
  - mkdocs-jupyter:
      include_source: true
      execute: false

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path: !relative $docs_dir
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - toc:
      permalink: true

exclude_docs: |
  hooks.py
  schemas/*.md

nav:
  - Home: index.md
  - End User:
      - users/index.md
      - Install the desktop app: users/install.md
      - Using the GUI: users/gui.md
      - Recipes:
          - users/recipes/index.md
          - Velocity analysis: users/recipes/velocity-analysis.md
          - Diameter analysis: users/recipes/diameter-analysis.md
          - Sum intensity analysis: users/recipes/sum-intensity-analysis.md
          - Analyses from velocity:
              - users/recipes/analyses-from-velocity/index.md
              - Velocity event analysis: users/recipes/analyses-from-velocity/velocity-event-analysis.md
              - Heart rate analysis: users/recipes/analyses-from-velocity/heart-rate-analysis.md
  - Data Scientist:
      - scientists/index.md
      - Velocity Analysis: scientists/velocity-analysis.md
      - Diameter Analysis: scientists/diameter-analysis.md
      - Sum Intensity Analysis: scientists/sum-intensity-analysis.md
      - AcqImage Metadata: scientists/acqimage-metadata.md
      - Notebooks:
          - scientists/notebooks.md
          - Load and Plot Image: notebooks/load-and-plot-image.ipynb
          - Velocity Analysis Notebook: notebooks/velocity-analysis.ipynb
          - Diameter Analysis Notebook: notebooks/diameter-analysis.ipynb
          - Sum Intensity Analysis Notebook: notebooks/sum-intensity-analysis.ipynb
          - Kymograph Reference Images: notebooks/kymograph-reference-image.ipynb
          - Heart Rate Analysis Notebook: notebooks/heart-rate-analysis.ipynb
          - Heart Rate Batch Analysis Notebook: notebooks/heart-rate-batch-analysis.ipynb
      - Reproducibility: scientists/reproducibility.md
  - Developer:
      - developers/index.md
      - Architecture: developers/architecture.md
      - Release and Deployment: developers/release-and-deployment.md
      - MkDocs style guide: developers/mkdocs-style.md
      - Contributing: developers/contributing.md
  - API:
      - api/index.md
      - AcqImage: api/acq-image.md
      - AcqImageList: api/acq-image-list.md
      - Analysis Core: api/analysis-core.md
      - Velocity Analysis: api/velocity-analysis.md
      - Diameter Analysis: api/diameter-analysis.md
      - Sum Intensity Analysis: api/sum-intensity-analysis.md
      - Batch Analysis: api/batch-analysis.md