-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathmkdocs.yml
143 lines (136 loc) · 3.89 KB
/
mkdocs.yml
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: typed-ffmpeg
site_description: Data validation using Python type hints
strict: true
site_url: https://livingbio.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: livingbio/typed-ffmpeg
repo_url: https://github.com/livingbio/typed-ffmpeg
edit_uri: edit/main/docs/
# https://www.mkdocs.org/user-guide/configuration/#validation
# validation:
# omitted_files: warn
# absolute_links: warn
# unrecognized_links: warn
nav:
- Get Started:
- Overview: index.md
- Usage:
- Basic API Usage: usage/basic-api-usage.ipynb
- Complex Filtering: usage/complex-filtering.ipynb
- Customizing Filters: usage/customizing-filters.ipynb
- Execute: usage/execute.ipynb
- API Documentation:
- ffmpeg: src/base.md
- types: src/types.md
- schema: src/schema.md
- filters: src/filters.md
- probe: src/probe.md
- exceptions: src/exceptions.md
- Common:
- serialize: src/common/serialize.md
- Streams:
- video stream: src/streams/video_stream.md
- audio stream: src/streams/audio_stream.md
- av stream: src/streams/av_stream.md
- DAG:
- compile: src/dag/compile.md
- context: src/dag/context.md
- nodes: src/dag/nodes.md
- schema: src/dag/schema.md
- utils: src/dag/utils.md
- validate: src/dag/validate.md
- global_runnable:
- runnable: src/dag/global_runnable/runnable.md
- global_args: src/dag/global_runnable/global_args.md
- utils:
- escaping: src/utils/escaping.md
- run: src/utils/run.md
- snapshot: src/utils/snapshot.md
- typing: src/utils/typing.md
- view: src/utils/view.md
- lazy_eval:
- schema: src/utils/lazy_eval/schema.md
- operator: src/utils/lazy_eval/operator.md
watch:
- "src"
- "docs"
- "README.md"
# https://www.mkdocs.org/user-guide/configuration/#validation
# validation:
# omitted_files: warn
# absolute_links: warn
# unrecognized_links: warn
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
plugins:
- search
- mknotebooks:
execute: false
timeout: 100
# preamble: "<path/to/your/script>"
allow_errors: true
- mkdocstrings:
handlers:
python:
options:
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