TopoStats/mkdocs.yml at main · AFM-SPM/TopoStats · 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
site_name: TopoStats
site_url: https://AFM-SPM.github.io/TopoStats/
repo_url: https://github.com/AFM-SPM/TopoStats/
theme:
  # name: terminal
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  # features:
  #   - navigation.sections

nav:
  - Home: index.md
  - Introduction: introduction.md
  - Usage:
      - usage/installation.md
      - usage/index.md
      - usage/configuration.md
      - usage/notebooks.md
      - usage/matplotlib-style.md
      - usage/data_dictionary.md
      - usage/workflow.md
  - Related Software: related_software.md
  - Glossary: glossary.md
  - FAQ: faq.md
  - Contributing:
      - contributing/index.md
      - contributing/adding_modules.md
  - Advanced Documentation:
      - advanced/index.md
      - advanced/classes.md
      - advanced/extending.md
      - advanced/flattening.md
      - advanced/grain_finding.md
      - advanced/thresholding.md
      - advanced/grainstats.md
      - advanced/disordered_tracing.md
      - advanced/nodestats.md
      - advanced/ordered_tracing.md
      - advanced/splining.md
  - API:
      - api/index.md
      - Array Manipulation: api/array_manipulation.md
      - Classes: api/classes.md
      - Config: api/config.md
      - Entry Point: api/entry_point.md
      - Filters: api/filters.md
      - Grains: api/grains.md
      - Grainstats: api/grainstats.md
      - IO: api/io.md
      - Logs:
          - api/logs/index.md
          - Logs: api/logs/logs.md
      - Measure:
          - api/measure/index.md
          - Curvature: api/measure/curvature.md
          - Feret: api/measure/feret.md
          - Geometry: api/measure/geometry.md
          - Height Profiles: api/measure/height_profiles.md
      - Plotting: api/plotting.md
      - PlottingFuncs: api/plottingfuncs.md
      - Processing: api/processing.md
      - Run Modules: api/run_modules.md
      - Scars: api/scars.md
      - Statistics: api/statistics.md
      - Theme: api/theme.md
      - Thresholds: api/thresholds.md
      - Tracing:
          - api/tracing/index.md
          - Disorderd Tracing: api/tracing/disordered_tracing.md
          - NodeStats: api/tracing/nodestats.md
          - Ordered Tracing: api/tracing/ordered_tracing.md
          - Pruning: api/tracing/pruning.md
          - Skeletonize: api/tracing/skeletonize.md
          - Splining: api/tracing/splining.md
          - Tracing Funcs: api/tracing/tracingfuncs.md
      - Utils: api/utils.md
      - Validation: api/validation.md

extra:
  version:
    provider: mike

plugins:
  - mermaid2
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_signature_annotations: true
  - mike:
      version_selector: true

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - 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

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js