-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
134 lines (123 loc) · 3.43 KB
/
mkdocs.yml
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
site_name: CitySeg
site_description: Documentation for the CitySeg urban semantic segmentation pipeline
site_author: Andrew Mitchell
repo_name: MitchellAcoustics/cityseg
repo_url: https://github.com/soundscape-labs/cityseg
edit_uri: 'docs/'
theme:
name: material
features:
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.sections
- navigation.top
- search.suggest
- search.highlight
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to light mode
nav:
- Home: index.md
- Getting Started: getting_started.md
- User Guide:
- Configuration: user_guide/configuration.md
# - Image Processing: user_guide/image_processing.md
# - Video Processing: user_guide/video_processing.md
# - Multi-Video Processing: user_guide/multi_video_processing.md
- API Reference:
- Config: api/config.md
- Pipeline: api/pipeline.md
- Processors: api/processors.md
- Segments Analysis: api/segments_analysis.md
- Handlers: api/handlers.md
- Utils: api/utils.md
- Palettes: api/palettes.md
- Exceptions: api/exceptions.md
- Contributing: contributing.md
- Changelog: changelog.md
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- pymdownx.caret
- pymdownx.details
- pymdownx.extra
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.magiclink
- pymdownx.smartsymbols
- pymdownx.snippets
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
options:
heading_level: 2
show_source: true
show_root_heading: false
show_root_full_path: true
show_category_heading: false # Could change this to true, not sure atm
show_symbol_type_heading: true # waiting for general release
show_symbol_type_toc: true
merge_init_into_class: true
ignore_init_summary: true
show_labels: false
parameter_headings: true
show_if_no_docstring: false
docstring_section_style: spacy
docstring_style: google
separate_signature: true
modernize_annotations: true # waiting for general release
members_order: source
# show_signature_annotations: true
show_signature: true
filter_private: true
# - mkdocs-jupyter:
# kernel_name: python3
# execute: true
# include_source: true
watch:
- src/cityseg
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/MitchellAcoustics
copyright: Copyright © 2024 Andrew Mitchell