histalign/mkdocs.yml at main · DuguidLab/histalign · 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
site_name: Histalign
repo_url: https://github.com/Duguidlab/histalign
repo_name: DuguidLab/histalign

theme:
  name: material
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.path
    - navigation.top
    - navigation.footer
    - content.code.copy
  icon:
    repo: fontawesome/brands/github
  font:
    text: Montserrat
  palette:
    - media: "(prefers-color-scheme: light)"
      primary: deep-orange
      accent: purple
      toggle:
        icon: material/moon-waxing-crescent
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep-orange
      accent: purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

extra_css:
  - css/icons.css

plugins:
  - caption:
      figure:
        ignore_alt: True
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            extensions:
              - griffe_pydantic:
  - search
  - section-index

markdown_extensions:
  - admonition
  - attr_list
  - mkdocs-click

copyright: Copyright &copy; 2024-Present Olivier Delrée

nav:
  - Getting started:
      - Installation: index.md
      - Typical workflow: typical-workflow.md
  - Tutorials:
      - Overview: tutorials/index.md
      - Data preparation: tutorials/data-preparation.md
      - Creating your first project: tutorials/your-first-project.md
      - Registration to the CCF: tutorials/registration.md
      - Building a 3D volume: tutorials/volume-building.md
      - Quantifying: tutorials/quantifying.md
      - Visualisation: tutorials/visualisation.md
  - Reference: reference/