ratiopath/mkdocs.yml at main · RationAI/ratiopath · 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
site_name: RatioPath
repo_url: https://github.com/RationAI/ratiopath

nav:
  - Home: index.md
  - Learn:
      - GET STARTED:
          - Quick Start:
              - learn/get-started/quick-start/index.md
              - learn/get-started/quick-start/tiling.md
              - learn/get-started/quick-start/annotations.md
              - learn/get-started/quick-start/overlays.md
              - learn/get-started/quick-start/tiled-dataset.md
          - learn/get-started/installation.md
  - Reference:
      - Tiling:
          - annotations: reference/tiling/annotations.md
          - overlays: reference/tiling/overlays.md
          - read_slide_tile: reference/tiling/read_slide_tile.md
          - tilers: reference/tiling/tilers.md
          - utils: reference/tiling/utils.md
      - Masks:
          - mask_builders: reference/masks/mask_builders.md
      - Parsers:
          - ASAPParser: reference/parsers/asap.md
          - GeoJSONParser: reference/parsers/geojson.md
          - Darwin7JSONParser: reference/parsers/darwin.md
      - Augmentations:
          - estimate_stain_vectors: reference/augmentations/estimate_stain_vectors.md
          - StainAugmentor: reference/augmentations/stain_augmentor.md
      - Ray:
          - Aggregations:
              - tensor_mean: reference/ray/aggregations/tensor_mean.md
              - tensor_std: reference/ray/aggregations/tensor_std.md
          - read_slides: reference/ray/read_slides.md
          - VipsTiffDatasink: reference/ray/vips_tiff_datasink.md
      - OpenSlide: reference/openslide.md

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tooltips
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_if_no_docstring: true

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption

extra:
  version:
    provider: mike