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
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/"
edit_uri: "edit/master/docs/"
site_dir: "site"
docs_dir: "docs"

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy
    - content.action.edit
    - content.action.view
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true

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
  - API Reference:
    - Overview: musicalgestures/index.md
    - Video: musicalgestures/_video.md
    - Audio: musicalgestures/_audio.md
    - Flow: musicalgestures/_flow.md
    - 360 Video: musicalgestures/_360video.md
    - Utils: musicalgestures/_utils.md
    - Complete Reference: MODULES.md
  - Development:
    - Contributing: contributing.md

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true

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