color-correction/mkdocs.yml at main · agfianf/color-correction · 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
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
site_name: color-correction
repo_url: https://github.com/agfianf/color-correction
repo_name: agfianf/color-correction
extra:
  generator: false
theme:
  name: 'material'
  language: en
  logo: 'assets/logo-v1.png'
  favicon: 'assets/logo-v1.png'
  font:
    text: 'Plus Jakarta Sans'
    code: 'Fira Code'
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
      primary: 1F69E9
      accent: grey

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/lightbulb-outline
        name: Switch to system preference
      primary: 1F69E9
      accent: white
  icon:
    repo: fontawesome/brands/square-github
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/regular/file-code

  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.action.view


markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - admonition
  - pymdownx.details
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - def_list
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: "¶"

plugins:
  - search
  - glightbox
  - mkdocstrings:
      handlers:
        python:
          paths: [.]  # actually not needed, default
          options:
            filters:
              - "!^_" # ignore objects starting with an underscore
              - "!^__" # ignore objects starting with a double underscore

            # docstrings
            docstring_style: numpy
            docstring_section_style: table
            show_if_no_docstring: false
            show_docstring_classes: true
            show_docstring_attributes: true
            show_docstring_functions: true
            show_docstring_modules: true
            show_docstring_examples: true
            show_docstring_other_parameters: true
            show_docstring_parameters: true
            show_docstring_raises: true
            show_docstring_receives: true
            show_docstring_returns: true
            show_docstring_warns: true
            show_docstring_yields: true

            # signature
            annotations_path: source # source, brief, full
            line_length: 79
            separate_signature: true
            show_signature_annotations: true

            # general
            show_source: true

            # headings
            parameter_headings: false
            show_bases: false
            show_root_heading: true
            show_root_full_path: false
            show_root_toc_entry: false
            show_root_members_full_path: false
            show_object_full_path: false
            group_by_category: true
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true

            # members
            members_order: source
            show_submodules: true
            show_labels: true

nav:
  - Home: index.md
  - Learn:
    - Getting Started: tutorial/getting_started.md
    - Color Correction: tutorial/color_correction.md
    - Correction Analyzer: tutorial/correction_analyzer.md
    - Detector: tutorial/detect_card.md
    - Troubleshooting: tutorial/troubleshooting.md
  - Architecture: architecture.md
  - Reference:
      - core:
        - card_detection:
          - YoloV8 ONNX: reference/core/card_detection/yv8_onnx.md
          - MCC Detector: reference/core/card_detection/mcc_detector.md
        - correction:
          - Least Squares: reference/core/correction/least_squares.md
          - Linear Regression: reference/core/correction/linear_reg.md
          - Affine Regression: reference/core/correction/affine_reg.md
          - Polynomial: reference/core/correction/polynomial.md
      - processor:
        - detection: reference/processor/detection.md
      - services:
        - color_correction: reference/services/color_correction.md
        - correction_analyzer: reference/services/correction_analyzer.md
      - schemas:
        - YoloV8 ONNX: reference/schemas/yv8_onnx.md
        - Custom Types: reference/schemas/custom_types.md
      - Exceptions: reference/exceptions.md
      - utils:
        - correction: reference/utils/correction.md
        - device_info: reference/utils/device_info.md
        - downloader: reference/utils/downloader.md
        - formater: reference/utils/formater.md
        - geometry_proccesing: reference/utils/geometry_proccesing.md
        - image_patch: reference/utils/image_patch.md
        - image_processing: reference/utils/image_processing.md
        - report_generator: reference/utils/report_generator.md
        - visualization_utils: reference/utils/visualization_utils.md
        - yolo_utils: reference/utils/yolo_utils.md