kneed/mkdocs.yml at main · arvkevi/kneed · 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
site_name: kneed
site_description: Knee-point detection in Python
site_url: https://kneed.readthedocs.io/
repo_url: https://github.com/arvkevi/kneed
repo_name: arvkevi/kneed

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.sections
    - navigation.expand
    - search.highlight
    - search.suggest

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
            members_order: source

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
    - Parameters: user-guide/parameters.md
    - Curve Types: user-guide/curve-types.md
    - Multi-Knee Detection: user-guide/multi-knee.md
    - Auto-Detection with find_shape: user-guide/find-shape.md
    - Troubleshooting: user-guide/troubleshooting.md
  - Examples:
    - K-Means Elbow Method: examples/kmeans-elbow.md
    - PCA Component Selection: examples/pca-components.md
    - Custom Data: examples/custom-data.md
  - API Reference: api.md
  - Changelog: changelog.md
  - Contributing: contributing.md