typed-ffmpeg/mkdocs.yml at main · lucemia/typed-ffmpeg · 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
site_name: typed-ffmpeg
site_description: Type-safe FFmpeg bindings for Python & TypeScript
strict: false
site_url: https://lucemia.github.io/typed-ffmpeg/

theme:
  name: 'material'
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb-outline
        name: 'Switch to dark mode'
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb
        name: 'Switch to light mode'
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - announce.dismiss
    - navigation.tabs

repo_name: lucemia/typed-ffmpeg
repo_url: https://github.com/lucemia/typed-ffmpeg
edit_uri: edit/main/docs/

watch:
  - 'packages/core/src'
  - 'packages/core/src'
  - 'packages/v5/src'
  - 'packages/v6/src'
  - 'packages/v7/src'
  - 'packages/v8/src'
  - 'docs'
  - 'README.md'

markdown_extensions:
  - attr_list
  - admonition
  - callouts
  - footnotes
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.extra
  - pymdownx.tilde
  - tables
  - toc:
      permalink: true
      title: Page contents

nav:
  - Get Started:
      - Overview: index.md
      - Packages (v4): v4-packages.md
      - Version Differences: version-differences.md
      - FAQ: faq.md
      - Migration from 3.x: migration/v3-to-v4.md
  - TypeScript: typescript.md
  - Usage:
      - Basic API Usage: usage/basic-api-usage.ipynb
      - Probe: usage/probe.ipynb
      - Complex Filtering: usage/complex-filtering.ipynb
      - Customizing Filters: usage/customizing-filters.ipynb
      - Execute: usage/execute.ipynb
  - Code Reference: reference/

plugins:
  - search
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mknotebooks:
      execute: false
      timeout: 100
      allow_errors: true
  - mkdocstrings:
      handlers:
        python:
          paths: [packages/core/src, docs/_stubs]
          options:
            show_source: false
            docstring_options:
              ignore_init_summary: true
            filters: ['!^_']
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            docstring_section_style: table
            order: source
            docstring_style: google
            extensions:
              - griffe_inherited_docstrings