-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
151 lines (140 loc) · 4.09 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
site_name: Quadra
site_url: https://orobix.github.io/quadra/
site_description: Quadra
repo_url: https://github.com/orobix/quadra
repo_name: Orobix/quadra
use_directory_urls: false
nav:
- Home: index.md
- Getting Started: getting_started.md
- Code Reference: reference/
- Tutorials:
- Datamodules: tutorials/datamodules.md
- Tasks: tutorials/tasks.md
- Configurations: tutorials/configurations.md
- Setting up devices: tutorials/devices_setup.md
- Reproducibility: tutorials/reproducibility.md
- Model Management: tutorials/model_management.md
- Export models for inference: tutorials/export.md
- External projects integration: tutorials/integration.md
- Contributing: tutorials/contribution.md
- Building documentation: tutorials/documentation.md
- Examples:
- Segmentation: tutorials/examples/segmentation.md
- Self-Supervised Learning: tutorials/examples/ssl.md
- Pytorch classification: tutorials/examples/classification.md
- Pytorch multilabel classification: tutorials/examples/multilabel_classification.md
- Sklearn classification: tutorials/examples/sklearn_classification.md
- Sklearn patch classification: tutorials/examples/sklearn_patch_classification.md
- Anomaly Detection: tutorials/examples/anomaly_detection.md
- Package Summary: reference/SUMMARY.md
- Changelog: reference/CHANGELOG.md
watch:
- quadra/
theme:
favicon: images/favicon.png
name: "material"
locale: en
custom_dir: docs_overrides
logo: images/quadra_logo.svg
icon:
repo: fontawesome/brands/github
font:
text: Roboto
code: Roboto Mono
palette:
- scheme: default
primary: teal
accent: light blue
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: teal
accent: light blue
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- content.code.annotate
- content.code.copy
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
plugins:
- search
- section-index
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/objects.inv
- https://mkdocstrings.github.io/griffe/objects.inv
- https://numpy.org/doc/stable/objects.inv
- https://pytorch.org/docs/master/objects.inv
options:
docstring_style: google
docstring_options:
ignore_init_summary: true
show_submodules: false
merge_init_into_class: true
docstring_section_style: list
show_if_no_docstring: false
heading_level: 3
extra:
version:
provider: mike
default:
- latest
generator: false
copyright: Copyright © 2023 Orobix
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
# Python Markdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
extra_css:
- css/colors.css
- css/mkdocstrings.css
- css/landing.css
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js