otary/mkdocs.yml at master · poupeaua/otary · 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
site_name: Otary
theme:
  name: material
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: white
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: black
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - content.code.annotate
    - content.code.copy
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  icon:
    repo: fontawesome/brands/github-alt
  logo: img/logo-bg-transparent.png
  favicon: img/logo-bg-transparent.png
  language: en

repo_name: poupeaua/otary
repo_url: https://github.com/poupeaua/otary

plugins:
  - search
  - autorefs:
      resolve_closest: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google

nav:
  - Home:
    - index.md
    - Why Otary?: why.md
    - Quickstart: quickstart.md
    - Installation: installation.md
    - PyPI Releases: https://pypi.org/project/otary

  - API:
      - api/index.md
      - Image: # -------------------------------- IMAGE -------------------------------
        - api/image/index.md

        - I/O:
          - api/image/io/index.md
          - Reader: api/image/io/reader.md
          - Writer: api/image/io/writer.md

        - Properties: api/image/properties.md
        - Conversion: api/image/conversion.md

        - Analysis:
          - api/image/analysis/index.md
          - Scoring: api/image/analysis/scoring.md

        - Transformers:
          - api/image/transformers/index.md
          - Cropping: api/image/transformers/cropping.md
          - Geometry: api/image/transformers/geometry.md
          - Morphology: api/image/transformers/morphology.md
          - Binarization & Thresholding: api/image/transformers/thresholding.md

        - Drawer:
          - api/image/drawer/index.md
          - Drawing: api/image/drawer/drawing.md
          - Renderers: api/image/drawer/renderers.md

      - Geometry: # ---------------------------- GEOMETRY -----------------------------
        - api/geometry/index.md

        - Discrete:
          - api/geometry/discrete/point.md

          - Shape:
            - Polygon: api/geometry/discrete/shape/polygon.md
            - Rectangle: api/geometry/discrete/shape/rectangle.md
            - Axis Aligned Rectangle: api/geometry/discrete/shape/axis_aligned_rectangle.md
            - Triangle: api/geometry/discrete/shape/triangle.md

          - Linear:
            - Segment: api/geometry/discrete/linear/segment.md
            - Linear Spline: api/geometry/discrete/linear/linear_spline.md

            - Directed:
              - Vector: api/geometry/discrete/linear/directed/vector.md
              - Vectorized Linear Spline: api/geometry/discrete/linear/directed/vectorized_linear_spline.md

        - Continuous:
          - Circle: api/geometry/continuous/circle.md
          - Ellipse: api/geometry/continuous/ellipse.md

  - Learn:
    - learn/index.md

  - About:
    - about/history.md
    - A Fair Advice: about/fair_advice.md
    - Contributing: about/contributing.md
    - License: about/license.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/poupeaua/otary
      name: GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/otary
      name: PyPI
  analytics:
    provider: google
    property: G-QJ0Z2ZWQJG

markdown_extensions:
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences