Aind.Behavior.VrForaging/mkdocs.yml at main · AllenNeuralDynamics/Aind.Behavior.VrForaging · 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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
site_name: AIND VR Foraging
site_description: AIND VR Foraging behavior experiment documentation
site_author: Bruno Cruz
copyright: 2026, Allen Institute for Neural Dynamics
repo_url: https://github.com/AllenNeuralDynamics/Aind.Behavior.VrForaging
repo_name: GitHub
docs_dir: docs

validation:
  links:
    not_found: warn
    absolute_links: warn
    unrecognized_links: info

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo.svg
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github
  palette:
    - scheme: default
      primary: white
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.instant
    - navigation.top
    - toc.follow
    - search.suggest
    - search.share

extra_css:
  - assets/stylesheets/extra.css
  - assets/stylesheets/pygments.css

hooks:
  - docs/hooks.py
  - docs/curricula_build.py

plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths:
            - src
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
          options:
            extensions:
              - griffe_typingdoc
            show_root_heading: true
            show_root_full_path: false
            show_if_no_docstring: true
            inherited_members: true
            members_order: source
            separate_signature: true
            unwrap_annotated: true
            filters:
              - "!^_"
            merge_init_into_class: true
            docstring_section_style: spacy
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_bases: true

markdown_extensions:
  - tables
  - toc:
      permalink: "#"
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.extra
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - API:
    - Overview: api/index.md
    - Session: api/session.md
    - Rig: api/rig.md
    - Task Logic: api/task_logic.md
    - Curricula: api/curricula.md
  - JSON Schemas: json-schemas.md
  - Data Contract: dataset.md