-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
199 lines (189 loc) · 5.27 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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
site_name: SiaPy
site_description: A tool for efficient processing of spectral images with Python.
strict: true
site_url: https://siapy.github.io/siapy-lib/
theme:
name: "material"
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: green
accent: green
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: green
accent: green
toggle:
icon: material/lightbulb
name: "Switch to light mode"
features:
- content.tabs.link
- content.code.annotate
- content.code.copy
- content.tabs.link
- content.tooltips
- content.footnote.tooltips
- navigation.tabs
- navigation.tabs.sticky
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.preview
- navigation.instant.progress
- navigation.path
- navigation.sections
- navigation.top
- navigation.tracking
- navigation.indexes
- navigation.footer
- search.highlight
- search.suggest
- search.share
- toc.follow
logo: "images/logo.svg"
favicon: "images/logo.png"
language: en
repo_name: siapy/siapy
repo_url: https://github.com/siapy/siapy-lib
extra:
version:
provider: mike
social:
- icon: fontawesome/brands/github
link: https://github.com/janezlapajne
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/janez-lapajne-b2270a139/
nav:
- Get Started:
- Welcome to SiaPy: index.md
- Installation: install.md
- Contributing: contributing.md
- Examples:
- Use cases: examples/use_cases.md
- Concepts:
- Introduction: examples/introduction.md
- Spectral Image: examples/spectral_image.md
- Spectral Image Set: examples/spectral_imageset.md
- Visualizations: examples/visualization.md
- Transformations: examples/transformations.md
- API Documentation:
- Core:
- Configs: api/core/configs.md
- Exceptions: api/core/exceptions.md
- Logger: api/core/logger.md
- Types: api/core/types.md
- Datasets:
- Helpers: api/datasets/helpers.md
- Schemas: api/datasets/schemas.md
- Tabular: api/datasets/tabular.md
- Entities:
- Images: api/entities/images.md
- Image Sets: api/entities/imagesets.md
- Pixels: api/entities/pixels.md
- Shapes: api/entities/shapes.md
- Signatures: api/entities/signatures.md
- Features:
- Features: api/features/features.md
- Helpers: api/features/helpers.md
- Spectral Indices: api/features/spectral_indices.md
- Models:
- Metrics: api/models/metrics.md
- Optimizers:
- Configs: api/optimizers/configs.md
- Optimizers: api/optimizers/optimizers.md
- Parameters: api/optimizers/parameters.md
- Scorers: api/optimizers/scorers.md
- Transformations:
- Corregistrator: api/transformations/corregistrator.md
- Image: api/transformations/image.md
- Utils:
- Evaluators: api/utils/evaluators.md
- Images: api/utils/images.md
- Plots: api/utils/plots.md
- Release Notes: changelog.md
- License: permit.md
markdown_extensions:
# Python Markdown
abbr:
attr_list:
footnotes:
md_in_html:
tables:
toc:
permalink: true
pymdownx.details:
pymdownx.extra:
pymdownx.snippets:
check_paths: true
# Python Markdown Extensions
pymdownx.betterem:
smart_enable: all
pymdownx.caret:
pymdownx.highlight:
line_spans: __span
pymdownx.inlinehilite:
pymdownx.keys:
pymdownx.mark:
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
pymdownx.tilde:
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator:
!!python/name:material.extensions.emoji.to_svg # pymdownx blocks
pymdownx.blocks.admonition:
types:
- note
- attention
- caution
- danger
- error
- tip
- hint
- warning
# Custom types
- info
- check
pymdownx.blocks.details:
pymdownx.blocks.tab:
alternate_style: True
watch:
- siapy
plugins:
- mike:
alias_type: symlink
canonical_version: latest
- search
- exclude:
glob:
- __pycache__/*
- mkdocstrings:
handlers:
python:
paths: [.]
options:
extensions:
- griffe_typingdoc
members_order: source
separate_signature: true
filters: ["!^_"]
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
show_if_no_docstring: true
show_signature_annotations: true
show_root_heading: true
inherited_members: true
signature_crossrefs: true
unwrap_annotated: true
docstring_section_style: spacy
show_symbol_type_heading: true
show_symbol_type_toc: true
import:
- https://docs.python.org/3/objects.inv
- external-markdown: