ethopy_analysis/mkdocs.yml at main · AthMic/ethopy_analysis · 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
site_name: Ethopy Analysis
site_description: Comprehensive Python package for analyzing behavioral data from Ethopy experiments
site_author: Ethopy Analysis Team
site_url: https://ef-lab.github.io/ethopy_analysis

repo_name: ethopy_analysis
repo_url: https://github.com/ef-lab/ethopy_analysis

theme:
  name: material
  palette:
    - scheme: slate
      primary: teal
      accent: indigo blue
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    - scheme: default
      primary: teal
      accent: indigo blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  logo: Ethopy_analysis_logo.png
  favicon: Ethopy_analysis_logo.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]

nav:
  - Home: index.md
  - Installation: installation.md
  - Quick Start: quickstart.md
  - Configuration: configuration.md
  - CLI Reference: cli.md
  - API Reference:
      - Data Loaders: API/data-loaders.md
      - Data Analysis: API/data-analysis.md
      - Animal Plots: API/plots-animal.md
      - Session Plots: API/plots-session.md
      - Comparison Plots: API/plots-comparison.md
      - Database: API/database.md
      - Configuration: API/config.md
      - CLI: API/cli.md
  - Troubleshooting: troubleshooting.md
  - Developers: developers.md

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

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ef-lab/ethopy_analysis