-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathmkdocs.yml
69 lines (64 loc) · 1.56 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
site_name: Typer Config
repo_name: maxb2/typer-config
repo_url: https://github.com/maxb2/typer-config
theme:
name: material
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.sections
- content.code.copy
- content.code.annotate
nav:
- Home: index.md
- Getting Started:
- install.md
- how.md
- Examples:
- 'examples/simple_yaml.md'
- 'examples/default_config.md'
- 'examples/pyproject.md'
- 'examples/pydantic.md'
- 'examples/schema.md'
- 'examples/explicit_config.md'
- 'examples/save_config.md'
- Known Issues: known_issues.md
- API Reference: api.md
- Changelog: changelog.md
markdown_extensions:
- pymdownx.highlight:
use_pygments: true
- pymdownx.superfences
plugins:
- search
- gen-files:
scripts:
- docs_gen_files.py
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
options:
docstring_style: google
show_docstring_warns: true
show_submodules: true
enable_inventory: true
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
- mike:
canonical_version: latest
version_selector: true
extra:
version:
provider: mike