VideoAnnotator/mkdocs.yml at master · InfantLab/VideoAnnotator · 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
site_name: VideoAnnotator
site_description: Run computer-vision and audio pipelines over videos of people, on your own computer.
site_url: https://infantlab.github.io/VideoAnnotator/
repo_url: https://github.com/InfantLab/VideoAnnotator
repo_name: InfantLab/VideoAnnotator
edit_uri: edit/master/docs/
docs_dir: docs
hooks:
  - scripts/mkdocs_hooks.py

# The archive keeps old documents as they were; handovers are working notes between sessions.
exclude_docs: |
  archive/
  development/handover_*.md
  *.docx

theme:
  name: material
  logo: imgs/VidAnnIcon.png
  favicon: imgs/VidAnnIcon.png
  features:
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle: { icon: material/brightness-7, name: Dark mode }
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle: { icon: material/brightness-4, name: Light mode }

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc: { permalink: true }
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.tabbed: { alternate_style: true }

validation:
  omitted_files: info
  absolute_links: info
  unrecognized_links: warn
  anchors: warn

nav:
  - Home: README.md
  - Install:
      - Installation: installation/INSTALLATION.md
      - Docker: deployment/Docker.md
      - Tokens for gated models: installation/ENVIRONMENT_SETUP.md
      - Installation troubleshooting: installation/troubleshooting.md
  - Use:
      - Getting started: usage/GETTING_STARTED.md
      - Command-line examples: usage/demo_commands.md
      - Pipelines: usage/pipeline_specs.md
      - Getting your results: usage/accessing_results.md
      - Results out (table, ELAN, methods): usage/exporting_results.md
      - Configuration: usage/configuration.md
      - Environment variables: usage/environment_variables.md
      - Connecting the viewer: usage/CLIENT_TOKEN_SETUP_GUIDE.md
      - Scene detection and tracking: usage/scene_detection.md
      - Troubleshooting: usage/troubleshooting.md
  - Run it for a group:
      - Security: security/README.md
      - Authentication: security/authentication.md
      - CORS: security/cors.md
      - Production checklist: security/production_checklist.md
      - Locales in Docker: locale.md
  - Contribute:
      - Development notes: development/README.md
      - Pre-commit hooks: development/PRE_COMMIT_GUIDE.md
      - Testing overview: testing/testing_overview.md
      - Testing standards: testing/testing_standards.md
      - Coverage: testing/coverage_report.md
      - Output naming: development/output_naming_conventions.md
      - Emotion output format: development/emotion_output_format.md
      - CORS and auth for frontends: development/CORS_AND_AUTH_PROTOCOL.md
      - VLM annotation pipeline: development/vlm_annotation_pipeline.md
      - Roadmap v1.6.0: development/roadmap_v1.6.0.md
      - Roadmap v1.7.0: development/roadmap_v1.7.0.md
      - Roadmap v1.8.0: development/roadmap_v1.8.0.md
      - Roadmap v1.8 to v2.0: development/roadmap_v1.8_to_v2.0.md
  - JOSS reviewers: GETTING_STARTED_REVIEWERS.md