Kabsch-Cookbook/mkdocs.yml at main · hunter-heidenreich/Kabsch-Cookbook · 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
site_name: Kabsch-Horn Alignment Cookbook
site_url: https://hunter-heidenreich.github.io/Kabsch-Cookbook/
site_description: Differentiable Kabsch (SVD) and Horn (Quaternion) alignment across NumPy, PyTorch, JAX, TensorFlow, and MLX.
site_author: Hunter Heidenreich
repo_url: https://github.com/hunter-heidenreich/Kabsch-Cookbook
repo_name: hunter-heidenreich/Kabsch-Cookbook

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest

plugins:
  - search
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            allow_inspection: false
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            docstring_style: google
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets:
      check_paths: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

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

nav:
  - Home: index.md
  - Getting Started: getting-started/index.md
  - Algorithms: algorithms/index.md
  - API Reference:
    - api/index.md
    - NumPy: api/numpy.md
    - PyTorch: api/pytorch.md
    - JAX: api/jax.md
    - TensorFlow: api/tensorflow.md
    - MLX: api/mlx.md
  - Guides: guides/index.md
  - Benchmarks: benchmarks/index.md
  - Contributing: contributing.md
  - Changelog: changelog.md