insect-detect-docs/mkdocs.yml at main · maxsitt/insect-detect-docs · 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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# Copyright (c) 2022-2026 Maximilian Sittinger <maximilian.sittinger@idiv.de>

# License: CC BY-SA 4.0 (http://creativecommons.org/licenses/by-sa/4.0/)
# You are free to share (copy and redistribute the material in any medium or
# format for any purpose, even commercially) and adapt (remix, transform, and
# build upon the material for any purpose, even commercially) the software and
# associated documentation under the following terms:
# Attribution: You must give appropriate credit, provide a link to the license,
# and indicate if changes were made. You may do so in any reasonable manner,
# but not in any way that suggests the licensor endorses you or your use.
# ShareAlike: If you remix, transform, or build upon the material, you must
# distribute your contributions under the same license as the original.
# No additional restrictions: You may not apply legal terms or technological
# measures that legally restrict others from doing anything the license permits.

# Project information
site_name: Insect Detect Docs
site_url: https://maxsitt.github.io/insect-detect-docs/
site_author: Maximilian Sittinger
site_description: >-
  Insect Detect: DIY camera trap for continuous automated insect monitoring -
   Documentation and build instructions

# Repository
repo_name: maxsitt/insect-detect-docs
repo_url: https://github.com/maxsitt/insect-detect-docs
edit_uri: ""

# Copyright
copyright: Copyright &copy; 2022 - 2026 Maximilian Sittinger

# Configuration
theme:
  name: material
  language: en
  features:
    - content.code.annotate
    - content.code.copy
    - header.autohide
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - scheme: slate
      primary: blue grey
      accent: teal
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
    - scheme: default
      primary: blue grey
      accent: teal
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
  font:
    text: Roboto
    code: Roboto Mono
  logo: assets/logo.png
  favicon: assets/favicon.png
  icon:
    repo: fontawesome/brands/github

# Plugins
plugins:
  - search
  - glightbox:
      width: 90%

# Additional configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/maxsitt
    - icon: fontawesome/brands/orcid
      link: https://orcid.org/0000-0002-4096-8556
    - icon: fontawesome/brands/researchgate
      link: https://researchgate.net/profile/Maximilian-Sittinger
    - icon: fontawesome/regular/envelope
      link: mailto:maximilian.sittinger@idiv.de
extra_css:
  - stylesheets/extra.css

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_title: Anchor link to this section
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

# Page tree
nav:
  - Introduction: index.md
  - Hardware:
    - hardware/index.md
    - Version 2024:
      - Components: hardware/2024_components.md
      - Building Instructions:
        - Overview: hardware/2024_buildinstructions_overview.md
        - Enclosure Preparation: hardware/2024_buildinstructions_enclosures.md
        - Hardware Integration: hardware/2024_buildinstructions_hardware.md
        - Mounting Setup: hardware/2024_buildinstructions_mounting.md
      - Field Deployment: hardware/2024_field_deployment.md
    - Version 2023:
      - Components: hardware/components.md
      - Building Instructions:
        - Overview: hardware/buildinstructions_overview.md
        - Preparing the Enclosure: hardware/buildinstructions_enclosure.md
        - Integrating the Hardware: hardware/buildinstructions_hardware.md
        - Mounting Setup: hardware/buildinstructions_mounting.md
  - Software:
    - software/index.md
    - Local Setup: software/localsetup.md
    - Raspberry Pi Setup: software/pisetup.md
    - Usage: software/usage.md
  - Model Training:
    - Annotation: modeltraining/annotation.md
    - Object Detection: modeltraining/train_detection.md
    - Image Classification: modeltraining/train_classification.md
  - Deployment:
    - Detection: deployment/detection.md
    - Classification: deployment/classification.md
    - Post-Processing: deployment/post-processing.md