kymflow/mkdocs.yml at main · mapmanager/kymflow · 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
site_name: KymFlow
site_description: Kymograph blood flow analysis tool
site_author: Robert H. Cudmore

repo_name: KymFlow Repository
repo_url: https://github.com/mapmanager/kymflow
edit_uri: ""

theme:
  name: material
  logo: 'images/kymflow.png'
  favicon: 'images/kymflow.png'
  custom_dir: 'docs/theme'
  palette:
    - scheme: slate
      primary: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.instant

extra_css:
  - theme/css/style.css
  - theme/css/extra.css

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist
  - pymdownx.details
  - toc:
      permalink: "¤"
      toc_depth: 3

watch:
  - docs

plugins:
  - search
  - autorefs
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          paths: [src/kymflow]
          options:
            show_root_heading: false
            show_root_toc_entry: true
            show_category_heading: true
            group_by_category: true
            heading_level: 2
            show_submodules: false
            show_source: true
            docstring_style: google

nav:
  - Home: index.md
  - Download: download.md
  - Declan Getting Started: declan-getting-started.md
  - Installation: user-guide/installation.md
  - Getting Started: user-guide/getting-started.md
  - GUI Usage: user-guide/gui-usage.md
  - Batch Processing: user-guide/batch-processing.md
  - File Formats: file-formats.md
  - Algorithms: algorithms.md
  - Notebooks: examples/notebooks.md
  - About: about.md