-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
88 lines (82 loc) · 2.39 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
# This file was generated from skeleton-ci/[email protected].
# Instead of changing this particular file, you might want to alter the template:
# https://github.com/skeleton-ci/skeleton-python/tree/0.0.2rc-245-g8c04714/project/%23%25%20if%20docs%20%25%23mkdocs.yml%23%25%20endif%20%25%23.jinja
site_name: "configzen"
site_description: "Manage configuration with pydantic."
site_url: "https://bswck.github.io/configzen"
repo_name: "bswck/configzen"
repo_url: "https://github.com/bswck/configzen"
watch:
- "configzen"
nav:
- "Overview": "index.md"
- "API Reference": "api.md"
- "Contributing": "contributing.md"
- "Code of Conduct": "code_of_conduct.md"
- "Changelog": "changelog.md"
theme:
name: "material"
features:
- "content.code.annotate"
- "navigation.top"
- "navigation.tracking"
palette:
- media: "(prefers-color-scheme: light)"
scheme: "default"
primary: "teal"
accent: "purple"
toggle:
icon: "material/weather-night"
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: "slate"
primary: "black"
accent: "lime"
toggle:
icon: "material/brightness-auto"
name: "Switch to system preference"
- media: "(prefers-color-scheme)"
toggle:
icon: "material/weather-sunny"
name: "Switch to light mode"
extra_css:
- "css/mkdocstrings.css"
markdown_extensions:
- "admonition"
- "footnotes"
- "pymdownx.emoji"
- "pymdownx.highlight":
use_pygments: true
- "pymdownx.magiclink"
- "pymdownx.superfences"
- "toc":
permalink: true
plugins:
- "autorefs"
- "search"
- "markdown-exec"
- "mkdocstrings":
handlers:
python:
options:
# https://mkdocstrings.github.io/python/usage/#configuration/
docstring_style: "numpy"
docstring_section_style: "list"
docstring_options:
ignore_init_summary: true
trim_doctest_flags: false
members_order: "source"
merge_init_into_class: true
parameter_headings: true
show_submodules: true
show_inheritance_diagram: false
show_signature_annotations: false
signature_crossrefs: true
line_length: 60
show_labels: false
show_symbol_type_heading: false
show_symbol_type_toc: true
summary: true
paths: ["configzen/"]
import:
- "https://docs.python.org/3/objects.inv"