AFMSlicer/mkdocs.yml at main · AFM-SPM/AFMSlicer · 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
site_name: AFMSlicer
site_url: https://AFMSlicer.readthedocs.org/
repo_url: https://github.com/AFM-SPM/AFMSlicer/
theme:
  name: material
  palette:
    # Palette toggle for automatic mode
    - media: (prefers-color-scheme)
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
nav:
  - Home: index.md
  - Introduction: introduction.md
  - Installation: installation.md
  - Usage:
      - Overview: usage/index.md
      - CLI: usage/cli.md
      - Configuration: usage/configuration.md
      - Napari: usage/napari.md
  - Workflow: workflow.md
  - Contributing:
      - Overview: contributing/index.md
      - Adding Modules: contributing/adding_modules.md
      - Napari: contributing/napari.md
  - API:
      # - afmslicer: api/afmslicer.md
      - API: api/index.md
      - slicer: api/slicer.md
      - validation: api/validation.md

extra:
  version:
    provider: mike

plugins:
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
          paths: [src]
          options.extra:
          docstring_options:
            ignore_init_summary: true
          docstring_section_style: true
          signature_crossrefs: true
          inherited_members: true
          summary: true
          heading_level: 1
          parameter_headings: true
          type_parameter_headings: true
  - autorefs
  - mermaid2
  - search

markdown_extensions:
  - admonition
  - pymdownx.blocks.tab
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.tabbed:
      alternate_style: true