vrAnalysis/mkdocs.yml at main · landoskape/vrAnalysis · 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
site_name: vrAnalysis Documentation
site_description: Documentation for vrAnalysis - Virtual Reality Analysis Package
site_author: Andrew Landau

repo_name: landoskape/vrAnalysis
repo_url: https://github.com/landoskape/vrAnalysis
edit_uri: edit/main/docs/

# GitHub Pages configuration
site_url: https://landoskape.github.io/vrAnalysis/

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  color_mode: dark
  use_color_mode_toggle: true
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.annotate

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            show_root_full_path: false
            show_if_no_docstring: false

nav:
  - Home: index.md
  - Installation: installation.md
  - Overview: overview.md
  - Workflows:
    - Overview: workflows/index.md
    - Registration: workflows/registration.md
  - API Reference:
    - sessions: api/sessions.md
    - b2sessions: api/b2session.md
    - database: api/database.md
    - registration: api/registration.md
    - processors: api/processors.md
  - Examples:
    - Overview: examples/index.md
    - Session Analysis: examples/session_analysis.md
  - Contributing: contributing.md