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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
site_name: "mkdocstrings-python"
site_description: "A Python handler for mkdocstrings."
site_url: "https://mkdocstrings.github.io/python"
repo_url: "https://github.com/mkdocstrings/python"
repo_name: "mkdocstrings/python"
site_dir: "site"
watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src/mkdocstrings_handlers]
copyright: Copyright © 2021 Timothée Mazzucotelli
edit_uri: edit/main/docs/
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
hooks:
- scripts/mkdocs_hooks.py
nav:
- Home:
- Overview: index.md
- Changelog: changelog.md
- Credits: credits.md
- License: license.md
- Usage:
- usage/index.md
- Configuration options:
- General: usage/configuration/general.md
- Headings: usage/configuration/headings.md
- Members: usage/configuration/members.md
- Docstrings: usage/configuration/docstrings.md
- Signatures: usage/configuration/signatures.md
- Docstring styles:
- Google: usage/docstrings/google.md
- Numpy: usage/docstrings/numpy.md
- Sphinx: usage/docstrings/sphinx.md
- Advanced:
- Customization: usage/customization.md
- Extensions: usage/extensions.md
- API reference: reference/api.md
- Development:
- Contributing: contributing.md
- Code of Conduct: code_of_conduct.md
# - Coverage report: coverage.md
- Insiders:
- insiders/index.md
- Getting started:
- Installation: insiders/installation.md
- Changelog: insiders/changelog.md
- mkdocstrings: https://mkdocstrings.github.io/
theme:
name: material
custom_dir: docs/.overrides
logo: logo.png
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.footer
- navigation.instant.preview
- navigation.path
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- search.highlight
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: lime
toggle:
icon: material/weather-night
name: Switch to system preference
extra_css:
- css/material.css
- css/mkdocstrings.css
- css/insiders.css
extra_javascript:
- js/feedback.js
markdown_extensions:
- abbr
- attr_list
- admonition
- callouts:
strip_period: no
- footnotes
- md_in_html
- pymdownx.blocks.admonition
- pymdownx.blocks.details
- pymdownx.blocks.tab:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
pygments_lang_class: true
- pymdownx.magiclink
- pymdownx.snippets:
auto_append: [docs/.glossary.md]
base_path: [!relative $config_dir]
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- toc:
permalink: "¤"
plugins:
- search
- autorefs
- markdown-exec
- section-index
# - coverage
- mkdocstrings:
handlers:
python:
paths: [src, docs/snippets]
inventories:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/objects.inv
- https://mkdocstrings.github.io/autorefs/objects.inv
- https://mkdocstrings.github.io/griffe/objects.inv
- https://python-markdown.github.io/objects.inv
options:
backlinks: tree
docstring_options:
ignore_init_summary: true
docstring_section_style: list
extensions: [scripts/griffe_extensions.py]
filters: public
heading_level: 1
inherited_members: true
line_length: 88
merge_init_into_class: true
parameter_headings: true
type_parameter_headings: true
preload_modules: [mkdocstrings]
relative_crossrefs: true
scoped_crossrefs: true
separate_signature: true
show_bases: false
show_inheritance_diagram: true
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
show_signature_type_parameters: true
show_source: false
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
summary: true
unwrap_annotated: true
- llmstxt:
full_output: llms-full.txt
sections:
Usage:
- index.md
API:
- reference/api.md
- git-revision-date-localized:
enabled: !ENV [DEPLOY, false]
enable_creation_date: true
type: timeago
- minify:
minify_html: !ENV [DEPLOY, false]
- redirects:
redirect_maps:
reference/mkdocstrings_handlers/python/index.md: reference/api.md
reference/mkdocstrings_handlers/python/config.md: reference/api.md#mkdocstrings_handlers.python.config
reference/mkdocstrings_handlers/python/debug.md: reference/api.md#mkdocstrings_handlers.python.debug
reference/mkdocstrings_handlers/python/handler.md: reference/api.md#mkdocstrings_handlers.python.handler
reference/mkdocstrings_handlers/python/rendering.md: reference/api.md#mkdocstrings_handlers.python.rendering
- group:
enabled: !ENV [MATERIAL_INSIDERS, false]
plugins:
- typeset
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/pawamoy
- icon: fontawesome/brands/mastodon
link: https://fosstodon.org/@pawamoy
- icon: fontawesome/brands/twitter
link: https://twitter.com/pawamoy
- icon: fontawesome/brands/gitter
link: https://gitter.im/mkdocstrings/python
- icon: fontawesome/brands/python
link: https://pypi.org/project/mkdocstrings-python/
analytics:
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: Let us know how we can improve this page.
|
