python-som/mkdocs.yml at master · andremsouza/python-som · 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
site_name: python-som
site_description: Python implementation of Kohonen's self-organizing map
site_url: https://andremsouza.github.io/python-som/
repo_url: https://github.com/andremsouza/python-som
repo_name: andremsouza/python-som
edit_uri: edit/master/docs/

theme:
  name: material
  features:
    - content.code.copy
    - navigation.sections
    - navigation.top
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

nav:
  - Home: index.md
  - Tutorial:
      - Your first map: tutorial/first-map.md
  - How-to:
      - Save and load a map: how-to/save-and-load-a-map.md
      - Reproduce a result: how-to/reproduce-a-result.md
      - Speed up training: how-to/speed-up-training.md
      - Use a custom strategy: how-to/use-a-custom-strategy.md
      - Use the estimator interface: how-to/use-with-scikit-learn.md
  - Reference:
      - Options and types: reference/options.md
      - Neighborhood functions: reference/neighborhood-functions.md
      - API: reference/api.md
      - Changelog: reference/changelog.md
  - Explanation:
      - Why isotropy matters: explanation/why-isotropy-matters.md
      - How batch training is computed: explanation/how-batch-training-is-computed.md
      - Why linear initialization is an SVD: explanation/why-linear-initialization-is-an-svd.md
      - Batch vs stepwise: explanation/batch-vs-stepwise.md
      - Artifact safety: explanation/artifact-safety.md
      - Comparison with MiniSom and SOMPY: explanation/comparison-with-som-libraries.md

plugins:
  - search
  # Every page moved when the docs were reorganised, and two of the old URLs are frozen in 0.3.0's
  # PyPI description, which can never be edited. These keep them working.
  - redirects:
      redirect_maps:
        getting-started.md: tutorial/first-map.md
        neighborhood-functions.md: reference/neighborhood-functions.md
        training-modes.md: explanation/batch-vs-stepwise.md
        options-and-types.md: reference/options.md
        save-and-load.md: how-to/save-and-load-a-map.md
        api.md: reference/api.md
        changelog.md: reference/changelog.md
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: sphinx
            show_source: true
            show_root_heading: true
            members_order: source
            separate_signature: true

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  # index.md and changelog.md pull in README.md and CHANGELOG.md from the repository root, so
  # those files stay single-sourced rather than duplicated into docs/.
  - pymdownx.snippets:
      base_path: [.]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - tables
  - toc:
      permalink: true

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

watch:
  - src/python_som