-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
132 lines (132 loc) · 3.87 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
site_name: !ENV [SITE_NAME, "typed-diskcache"]
site_url: https://typed-diskcache.readthedocs.io
repo_url: https://github.com/phi-friday/typed-diskcache
repo_name: phi-friday/typed-diskcache
docs_dir: src/docs
site_author: Choi Min-yeong
copyright: 2024, Choi Min-yeong
watch:
- src/typed_diskcache
- README.md
nav:
- README: index.md
- LICENSES:
- LICENSE: licenses/license.md
- python-diskcache: licenses/python-diskcache.md
- API:
- Cache:
- Cache: api/cache/cache.md
- FanoutCache: api/cache/fanout.md
- CacheProtocol: api/cache/cache_protocol.md
- Disk:
- Disk: api/disk/disk.md
- DiskProtocol: api/disk/disk_protocol.md
- Synchronization:
- Lock: api/sync/lock.md
- LockProtocol: api/sync/lock_protocol.md
- Semaphore: api/sync/semaphore.md
- SemaphoreProtocol: api/sync/semaphore_protocol.md
- Utils:
- Deque: api/utils/deque.md
- Memoize: api/utils/memo.md
- Types:
- Types: api/types/types.md
- Models: api/types/models.md
- Exception: api/types/exception.md
theme:
name: material
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- navigation.instant
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- search.suggest
- search.highlight
- toc.follow
- content.code.copy
markdown_extensions:
- pymdownx.snippets
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.highlight:
linenums: true
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- admonition
plugins:
- search
- autorefs
- mkdocstrings:
handlers:
python:
paths:
- src
import:
- url: https://docs.python.org/3/objects.inv
domains: [std, py]
- https://typing-extensions.readthedocs.io/en/stable/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
options:
extensions:
- griffe_pydantic:
schema: true
- griffe_inherited_docstrings:
merge: true
# general
allow_inspection: true
show_bases: true
show_source: true
# title
heading_level: 2
parameter_headings: true
show_root_toc_entry: true
show_root_heading: true
show_root_full_path: false
show_root_members_full_path: false
show_object_full_path: false
show_symbol_type_heading: true
show_symbol_type_toc: true
# members
members: null
inherited_members: true
members_order: source
summary: false
show_labels: true
filters:
- "!^_[^_]"
# docstring
docstring_style: google
docstring_options:
ignore_init_summary: true
trim_doctest_flags: true
docstring_section_style: table
merge_init_into_class: true
# signatures
annotations_path: "brief"
line_length: 60
show_signature: true
show_signature_annotations: true
separate_signature: true
signature_crossrefs: true
unwrap_annotated: true