MGT-python/mkdocs.yml at master · fourMs/MGT-python · 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
site_name: "MGT-python: Musical Gestures Toolbox"
site_description: "Musical Gestures Toolbox for Python - Tools for visualization and analysis of audio and video"
site_url: https://fourms.github.io/MGT-python/
repo_url: https://github.com/fourMs/MGT-python
repo_name: fourMs/MGT-python
edit_uri: edit/master/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      toggle:
        icon: material/brightness-4
        name: Light mode
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quick Start: quickstart.md
      - Examples: examples.md
  - User Guide:
      - Core Classes: user-guide/core-classes.md
      - Loading & Showing: user-guide/loading.md
      - Preprocessing: user-guide/preprocessing.md
      - Video Analysis: user-guide/video-analysis.md
      - Audio Analysis: user-guide/audio-analysis.md
      - Audio-Video Analysis: user-guide/audio-video.md
      - Pose Tracking: user-guide/pose-tracking.md
      - Sound-Movement Analysis Toolkit: user-guide/sound-movement-toolkit.md
      - Working with Results: user-guide/results.md
  - API Reference:
      - Overview: musicalgestures/index.md
      - Video: musicalgestures/_video.md
      - Audio: musicalgestures/_audio.md
      - Flow: musicalgestures/_flow.md
      - 360 Video: musicalgestures/_360video.md
      - Anglegram (360): musicalgestures/_anglegram.md
      - Utils: musicalgestures/_utils.md
      - Complete Reference: MODULES.md
  - Development:
      - Contributing: contributing.md

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
  # Old page URLs that must keep resolving. mkdocs-redirects writes a small
  # meta-refresh page at each old path, so an external bookmark still lands.
  - redirects:
      redirect_maps:
        musicalgestures/_centroid.md: musicalgestures/index.md
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: auto
            show_source: true
            members_order: source
            merge_init_into_class: true
            separate_signature: true

markdown_extensions:
  - admonition
  - tables
  - pymdownx.highlight
  - pymdownx.superfences
  - toc:
      permalink: true