vidiopy/mkdocs.yml at master · SohamTilekar/vidiopy · 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
site_name: VidioPy
site_author: Soham Tilekar
site_description: A Python Video Editing Library
site_url: https://github.com/SohamTilekar/vidiopy

repo_name: SohamTilekar/vidiopy
repo_url: https://github.com/SohamTilekar/vidiopy
edit_uri: edit/master/docs/

copyright: Copyright &copy; 2023 - 2024 Soham Tilekar Under MIT License

nav:
  - Home: index.md
  - Documentation:
      - Installation: getting_started/download_install.md
      - Getting Started:
          - Quick Presentation: getting_started/quick_presentation.md
          - Basic Concepts: getting_started/basic_concepts.md
          - Read & Write: getting_started/read&write.md
          - Mixing Clips: getting_started/mixing_clip.md
      - Reference Manual:
          - Reference Manual: reference_manual/reference_manual.md
          - Clip: reference_manual/clips/clip.md
          - VideoClips:
              - VideoClip: reference_manual/clips/video_clips/videoclip.md
              - VideoFileClip: reference_manual/clips/video_clips/videofileclip.md
              - ImageClip: reference_manual/clips/video_clips/imageclips.md
              - ImageSequenceClip: reference_manual/clips/video_clips/imagesequenceclip.md
              - Mixing VideoClip: reference_manual/clips/video_clips/mixing_clips.md
          - AudioClips:
              - AudioClip: reference_manual/clips/audio_clips/audioclip.md
              - AudioFileClip: reference_manual/clips/audio_clips/audiofileclip.md
              - AudioArrayClip: reference_manual/clips/audio_clips/audioarrayclip.md
              - SilenceClip: reference_manual/clips/audio_clips/silenceclip.md
              - Mixing AudioClip: reference_manual/clips/audio_clips/mixingaudio.md

  - Contribute:
      - Contributing: more/CONTRIBUTING.md
      - Style Guide: more/code style guide.md

theme:
  name: material
  custom_dir: overrides
  logo: media/vidiopy_logo.png
  favicon: media/vidiopy_logo.png
  icon:
    annotation: material/more
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - header.autohide
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.instant.preview
    - navigation.path
    - navigation.prune
    - navigation.tracking
    - content.action.edit
    - content.action.view
    - toc.follow

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            heading_level: 2

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.betterem:
      smart_enable: all
  - 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
  - pymdownx.betterem
  - pymdownx.keys
  - pymdownx.details
  - abbr
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - footnotes
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols

extra:
  # generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SohamTilekar/vidiopy
    - icon: fontawesome/solid/paper-plane
      link: mailto:sohamtilekar233@gmail.com

extra_css:
  - "stylesheets/extra.css"