TPTBox/mkdocs.yml at main · Hendrik-code/TPTBox · 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
site_name: TPTBox
site_description: Torso Processing Toolbox — BIDS-compliant medical image processing for CT and MRI.
site_url: https://tptbox.readthedocs.io
repo_url: https://github.com/Hendrik-code/TPTBox
repo_name: Hendrik-code/TPTBox
edit_uri: blob/main/

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

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            unwrap_annotated: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ["."]
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Modules:
      - Core: modules/core.md
      - POI Strategies: modules/poi_fun.md
      - Spine: modules/spine.md
      - "Spine – 2D Snapshots": modules/snapshot2d.md
      - "Spine – Statistics": modules/spinestats.md
      - Registration: modules/registration.md
      - Segmentation: modules/segmentation.md
      - Mesh 3D: modules/mesh3d.md
      - Stitching: modules/stitching.md
      - Logger: modules/logger.md
  - API Reference:
      - Core:
          - NII (NIfTI wrapper): api/nii.md
          - POI (Points of Interest): api/poi.md
          - BIDS Files: api/bids.md
          - NumPy Utilities: api/np_utils.md
          - Vertebra Constants: api/vert_constants.md
          - POI Strategies: api/poi_fun.md
      - Spine: api/spine.md
      - Registration: api/registration.md
      - Segmentation: api/segmentation.md
      - Mesh 3D: api/mesh3d.md
      - Stitching: api/stitching.md
      - Logger: api/logger.md