renderkit/mkdocs.yml at main · Ahmed-Hindy/renderkit · 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
site_name: RenderKit
site_description: A high-performance image and video processor for VFX workflows.
site_author: Ahmed Hindy
repo_url: https://github.com/Ahmed-Hindy/renderkit
repo_name: Ahmed-Hindy/renderkit

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.expand
    - navigation.indexes

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_root_heading: true
            show_source: true

nav:
  - Home: index.md
  - Usage Guide: usage.md
  - Development: development.md
  - Contributing: contributing.md
  - API Reference:
      - Core:
          - RenderKit: api/processor.md
          - Config: api/config.md
          - Sequence: api/sequence.md
      - IO:
          - ImageReader: api/io/image_reader.md
          - FileUtils: api/io/file_utils.md
      - Processing:
          - ColorSpace: api/processing/color_space.md
          - Scaler: api/processing/scaler.md
          - VideoEncoder: api/processing/video_encoder.md
          - ContactSheet: api/processing/contact_sheet.md