-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
181 lines (147 loc) · 66 KB
/
index.html
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
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Automatic documentation from sources, for MkDocs."><link href=https://mkdocstrings.github.io/troubleshooting/ rel=canonical><link href=../recipes/ rel=prev><link href=../reference/mkdocstrings/ rel=next><link rel=icon href=../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.6.9+insiders-4.53.16"><title>Troubleshooting - mkdocstrings</title><link rel=stylesheet href=../assets/stylesheets/main.ade31302.min.css><link rel=stylesheet href=../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../assets/_markdown_exec_pyodide.css><link rel=stylesheet href=../css/timeago.css><link rel=stylesheet href=../assets/_mkdocstrings.css><link rel=stylesheet href=../css/style.css><link rel=stylesheet href=../css/material.css><link rel=stylesheet href=../css/mkdocstrings.css><link rel=stylesheet href=../css/insiders.css><script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#troubleshooting class=md-skip> Skip to content </a> </div> <div data-md-component=announce> <aside class=md-banner> <div class="md-banner__inner md-grid md-typeset"> <button class="md-banner__button md-icon" aria-label="Don't show this again"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> <strong>Fund this project</strong> through <a href=../insiders/#how-to-become-a-sponsor><strong>sponsorship</strong></a> <span class="twemoji heart pulse"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M7.655 14.916zh-.002l-.006-.003-.018-.01a22 22 0 0 1-3.744-2.584C2.045 10.731 0 8.35 0 5.5 0 2.836 2.086 1 4.25 1 5.797 1 7.153 1.802 8 3.02 8.847 1.802 10.203 1 11.75 1 13.914 1 16 2.836 16 5.5c0 2.85-2.044 5.231-3.886 6.818a22 22 0 0 1-3.433 2.414 7 7 0 0 1-.31.17l-.018.01-.008.004a.75.75 0 0 1-.69 0"/></svg> </span> — Follow <strong>@pawamoy</strong> on <a rel=me href=https://fosstodon.org/@pawamoy> <span class="twemoji mastodon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M433 179.11c0-97.2-63.71-125.7-63.71-125.7-62.52-28.7-228.56-28.4-290.48 0 0 0-63.72 28.5-63.72 125.7 0 115.7-6.6 259.4 105.63 289.1 40.51 10.7 75.32 13 103.33 11.4 50.81-2.8 79.32-18.1 79.32-18.1l-1.7-36.9s-36.31 11.4-77.12 10.1c-40.41-1.4-83-4.4-89.63-54a102.5 102.5 0 0 1-.9-13.9c85.63 20.9 158.65 9.1 178.75 6.7 56.12-6.7 105-41.3 111.23-72.9 9.8-49.8 9-121.5 9-121.5m-75.12 125.2h-46.63v-114.2c0-49.7-64-51.6-64 6.9v62.5h-46.33V197c0-58.5-64-56.6-64-6.9v114.2H90.19c0-122.1-5.2-147.9 18.41-175 25.9-28.9 79.82-30.8 103.83 6.1l11.6 19.5 11.6-19.5c24.11-37.1 78.12-34.8 103.83-6.1 23.71 27.3 18.4 53 18.4 175z"/></svg> </span> <strong>Fosstodon</strong> </a> for updates </div> <script>var el=document.querySelector("[data-md-component=announce]");if(el){var content=el.querySelector(".md-typeset");__md_hash(content.innerHTML)===__md_get("__announce")&&(el.hidden=!0)}</script> </aside> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=.. title=mkdocstrings class="md-header__button md-logo" aria-label=mkdocstrings data-md-component=logo> <img src=../logo.svg alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> mkdocstrings </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Troubleshooting </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media=(prefers-color-scheme) data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=teal data-md-color-accent=purple aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_2 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=black data-md-color-accent=lime aria-label="Switch to system preference" type=radio name=__palette id=__palette_2> <label class="md-header__button md-icon" title="Switch to system preference" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class=md-search__options aria-label=Search> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> <div class=md-search__suggest data-md-component=search-suggest></div> </form> <div class=md-search__output> <div class=md-search__scrollwrap tabindex=0 data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/mkdocstrings/mkdocstrings title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class=md-source__repository> mkdocstrings/mkdocstrings </div> </a> </div> </nav> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=.. class=md-tabs__link> Home </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../usage/ class=md-tabs__link> Usage </a> </li> <li class=md-tabs__item> <a href=../reference/mkdocstrings/ class=md-tabs__link> API reference </a> </li> <li class=md-tabs__item> <a href=../contributing/ class=md-tabs__link> Development </a> </li> <li class=md-tabs__item> <a href=../insiders/ class=md-tabs__link> Insiders </a> </li> <li class=md-tabs__item> <a href=https://pawamoy.github.io/ class=md-tabs__link> Author's website </a> </li> </ul> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=.. title=mkdocstrings class="md-nav__button md-logo" aria-label=mkdocstrings data-md-component=logo> <img src=../logo.svg alt=logo> </a> mkdocstrings </label> <div class=md-nav__source> <a href=https://github.com/mkdocstrings/mkdocstrings title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class=md-source__repository> mkdocstrings/mkdocstrings </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_1> <label class=md-nav__link for=__nav_1 id=__nav_1_label tabindex=0> <span class=md-ellipsis> Home </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_1_label aria-expanded=false> <label class=md-nav__title for=__nav_1> <span class="md-nav__icon md-icon"></span> Home </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=.. class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../changelog/ class=md-nav__link> <span class=md-ellipsis> Changelog </span> </a> </li> <li class=md-nav__item> <a href=../credits/ class=md-nav__link> <span class=md-ellipsis> Credits </span> </a> </li> <li class=md-nav__item> <a href=../license/ class=md-nav__link> <span class=md-ellipsis> License </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2 checked> <div class="md-nav__link md-nav__container"> <a href=../usage/ class="md-nav__link "> <span class=md-ellipsis> Usage </span> </a> <label class="md-nav__link " for=__nav_2 id=__nav_2_label tabindex> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=true> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Usage </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../usage/theming/ class=md-nav__link> <span class=md-ellipsis> Theming </span> </a> </li> <li class=md-nav__item> <a href=../usage/handlers/ class=md-nav__link> <span class=md-ellipsis> Handlers </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2_3> <label class=md-nav__link for=__nav_2_3 id=__nav_2_3_label tabindex> <span class=md-ellipsis> All handlers </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_3_label aria-expanded=false> <label class=md-nav__title for=__nav_2_3> <span class="md-nav__icon md-icon"></span> All handlers </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=https://mkdocstrings.github.io/c/ class=md-nav__link> <span class=md-ellipsis> C </span> </a> </li> <li class=md-nav__item> <a href=https://mkdocstrings.github.io/crystal/ class=md-nav__link> <span class=md-ellipsis> Crystal </span> </a> </li> <li class=md-nav__item> <a href=https://mkdocstrings.github.io/python/ class=md-nav__link> <span class=md-ellipsis> Python </span> </a> </li> <li class=md-nav__item> <a href=https://mkdocstrings.github.io/python-legacy/ class=md-nav__link> <span class=md-ellipsis> Python (Legacy) </span> </a> </li> <li class=md-nav__item> <a href=https://mkdocstrings.github.io/shell/ class=md-nav__link> <span class=md-ellipsis> Shell </span> </a> </li> <li class=md-nav__item> <a href=https://mkdocstrings.github.io/typescript/ class=md-nav__link> <span class=md-ellipsis> TypeScript </span> </a> </li> <li class=md-nav__item> <a href=https://pypi.org/project/mkdocstrings-vba class=md-nav__link> <span class=md-ellipsis> VBA </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2_4 checked> <label class=md-nav__link for=__nav_2_4 id=__nav_2_4_label tabindex> <span class=md-ellipsis> Guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_4_label aria-expanded=true> <label class=md-nav__title for=__nav_2_4> <span class="md-nav__icon md-icon"></span> Guides </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../recipes/ class=md-nav__link> <span class=md-ellipsis> Recipes </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Troubleshooting </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Troubleshooting </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#code-blocks-in-admonitions-in-docstrings-or-else-are-not-rendered-correctly class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Code blocks in admonitions (in docstrings or else) are not rendered correctly </span> </span> </a> </li> <li class=md-nav__item> <a href=#footnotes-are-duplicated-or-overridden class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Footnotes are duplicated or overridden </span> </span> </a> </li> <li class=md-nav__item> <a href=#mkdocs-warns-me-about-links-to-unfound-documentation-files class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> MkDocs warns me about links to unfound documentation files </span> </span> </a> </li> <li class=md-nav__item> <a href=#some-objects-are-not-rendered-they-do-not-appear-in-the-generated-docs class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Some objects are not rendered (they do not appear in the generated docs) </span> </span> </a> </li> <li class=md-nav__item> <a href=#tabs-in-docstrings-from-pymdownxtabbed-are-not-working-properly class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Tabs in docstrings (from <code>pymdownx.tabbed</code>) are not working properly </span> </span> </a> </li> <li class=md-nav__item> <a href=#the-generated-documentation-does-not-look-good class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> The generated documentation does not look good </span> </span> </a> </li> <li class=md-nav__item> <a href=#warning-could-not-find-cross-reference-target class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Warning: could not find cross-reference target </span> </span> </a> </li> <li class=md-nav__item> <a href=#python-specifics class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Python specifics </span> </span> </a> <nav class=md-nav aria-label="Python specifics"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#nothing-is-rendered-at-all class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Nothing is rendered at all </span> </span> </a> </li> <li class=md-nav__item> <a href=#latex-in-docstrings-is-not-rendered-correctly class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> LaTeX in docstrings is not rendered correctly </span> </span> </a> </li> <li class=md-nav__item> <a href=#my-docstrings-in-comments-are-not-picked-up class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> My docstrings in comments (<code>#:</code>) are not picked up </span> </span> </a> </li> <li class=md-nav__item> <a href=#my-wrapped-function-shows-documentationcode-for-its-wrapper-instead-of-its-own class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> My wrapped function shows documentation/code for its wrapper instead of its own </span> </span> </a> </li> <li class=md-nav__item> <a href=#footnotes-do-not-render class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Footnotes do not render </span> </span> </a> </li> <li class=md-nav__item> <a href=#submodules-are-not-rendered class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Submodules are not rendered </span> </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../reference/mkdocstrings/ class=md-nav__link> <span class=md-ellipsis> API reference </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex=0> <span class=md-ellipsis> Development </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Development </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../contributing/ class=md-nav__link> <span class=md-ellipsis> Contributing </span> </a> </li> <li class=md-nav__item> <a href=../code_of_conduct/ class=md-nav__link> <span class=md-ellipsis> Code of Conduct </span> </a> </li> <li class=md-nav__item> <a href=../coverage/ class=md-nav__link> <span class=md-ellipsis> Coverage report </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5> <div class="md-nav__link md-nav__container"> <a href=../insiders/ class="md-nav__link "> <span class=md-ellipsis> Insiders </span> </a> <label class="md-nav__link " for=__nav_5 id=__nav_5_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> Insiders </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5_1> <label class=md-nav__link for=__nav_5_1 id=__nav_5_1_label tabindex=0> <span class=md-ellipsis> Getting started </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_1_label aria-expanded=false> <label class=md-nav__title for=__nav_5_1> <span class="md-nav__icon md-icon"></span> Getting started </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../insiders/installation/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../insiders/changelog/ class=md-nav__link> <span class=md-ellipsis> Changelog </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=https://pawamoy.github.io/ class=md-nav__link> <span class=md-ellipsis> Author's website </span> </a> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#code-blocks-in-admonitions-in-docstrings-or-else-are-not-rendered-correctly class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Code blocks in admonitions (in docstrings or else) are not rendered correctly </span> </span> </a> </li> <li class=md-nav__item> <a href=#footnotes-are-duplicated-or-overridden class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Footnotes are duplicated or overridden </span> </span> </a> </li> <li class=md-nav__item> <a href=#mkdocs-warns-me-about-links-to-unfound-documentation-files class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> MkDocs warns me about links to unfound documentation files </span> </span> </a> </li> <li class=md-nav__item> <a href=#some-objects-are-not-rendered-they-do-not-appear-in-the-generated-docs class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Some objects are not rendered (they do not appear in the generated docs) </span> </span> </a> </li> <li class=md-nav__item> <a href=#tabs-in-docstrings-from-pymdownxtabbed-are-not-working-properly class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Tabs in docstrings (from <code>pymdownx.tabbed</code>) are not working properly </span> </span> </a> </li> <li class=md-nav__item> <a href=#the-generated-documentation-does-not-look-good class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> The generated documentation does not look good </span> </span> </a> </li> <li class=md-nav__item> <a href=#warning-could-not-find-cross-reference-target class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Warning: could not find cross-reference target </span> </span> </a> </li> <li class=md-nav__item> <a href=#python-specifics class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Python specifics </span> </span> </a> <nav class=md-nav aria-label="Python specifics"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#nothing-is-rendered-at-all class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Nothing is rendered at all </span> </span> </a> </li> <li class=md-nav__item> <a href=#latex-in-docstrings-is-not-rendered-correctly class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> LaTeX in docstrings is not rendered correctly </span> </span> </a> </li> <li class=md-nav__item> <a href=#my-docstrings-in-comments-are-not-picked-up class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> My docstrings in comments (<code>#:</code>) are not picked up </span> </span> </a> </li> <li class=md-nav__item> <a href=#my-wrapped-function-shows-documentationcode-for-its-wrapper-instead-of-its-own class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> My wrapped function shows documentation/code for its wrapper instead of its own </span> </span> </a> </li> <li class=md-nav__item> <a href=#footnotes-do-not-render class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Footnotes do not render </span> </span> </a> </li> <li class=md-nav__item> <a href=#submodules-are-not-rendered class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Submodules are not rendered </span> </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <nav class=md-path aria-label=Navigation> <ol class=md-path__list> <li class=md-path__item> <a href=../usage/ class=md-path__link> <span class=md-ellipsis> Usage </span> </a> </li> <li class=md-path__item> <a href=../recipes/ class=md-path__link> <span class=md-ellipsis> Guides </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <a href=https://github.com/mkdocstrings/mkdocstrings/edit/main/docs/troubleshooting.md title="Edit this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> </a> <a href=https://github.com/mkdocstrings/mkdocstrings/raw/main/docs/troubleshooting.md title="View source of this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg> </a> <h1 id=troubleshooting>Troubleshooting<a class=headerlink href=#troubleshooting title="Permanent link">¤</a></h1> <h2 id=code-blocks-in-admonitions-in-docstrings-or-else-are-not-rendered-correctly>Code blocks in admonitions (in docstrings or else) are not rendered correctly<a class=headerlink href=#code-blocks-in-admonitions-in-docstrings-or-else-are-not-rendered-correctly title="Permanent link">¤</a></h2> <p>To render code blocks in admonitions, you need to add the <code>pymdownx.superfences</code> extensions to the list of Markdown extensions in <code>mkdocs.yml</code>. For example:</p> <div class="language-markdown highlight"><pre><span></span><code>!!! note
Some text.
<span class=sb> ```bash</span>
<span class=w> </span><span class=nb>echo</span><span class=w> </span><span class=s2>"some code"</span>
<span class=sb> ```</span>
</code></pre></div> <div class="language-yaml highlight"><span class=filename>mkdocs.yml</span><pre><span></span><code><span class=nt>markdown_extensions</span><span class=p>:</span>
<span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">admonition</span>
<span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">codehilite</span>
<span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">pymdownx.superfences</span>
</code></pre></div> <p>For code blocks in docstrings, make sure to escape newlines (<code>\n</code> -> <code>\\n</code>), or prefix the entire docstring with 'r' to make it a raw-docstring: <code>r"""</code>. Indeed, docstrings are still strings and therefore subject to how Python parses strings.</p> <h2 id=footnotes-are-duplicated-or-overridden>Footnotes are duplicated or overridden<a class=headerlink href=#footnotes-are-duplicated-or-overridden title="Permanent link">¤</a></h2> <p>Before version 0.14, footnotes could be duplicated over a page. Please upgrade to version 0.14 or higher.</p> <p>See also:</p> <ul> <li><a href=https://github.com/mkdocstrings/mkdocstrings/issues/186>Issue #186</a></li> <li><a href=#tabs-in-docstrings-from-pymdownxtabbed-are-not-working-properly>Tabs in docstrings (from <code>pymdownx.tabbed</code>) are not working properly</a>.</li> </ul> <h2 id=mkdocs-warns-me-about-links-to-unfound-documentation-files>MkDocs warns me about links to unfound documentation files<a class=headerlink href=#mkdocs-warns-me-about-links-to-unfound-documentation-files title="Permanent link">¤</a></h2> <p>A warning like this one:</p> <blockquote> <p>WARNING - Documentation file 'reference/parsers/docstrings.md' contains a link to 'reference/parsers/pytkdocs.parsers.docstrings.Section' which is not found in the documentation files.</p> </blockquote> <p>...generally means you used parentheses <code>()</code> instead of brackets <code>[]</code> for a cross-reference. Notice the dots in <code>reference/parsers/pytkdocs.parsers.docstrings.Section</code>? It shows that it's probably a cross-reference, not a direct link. It's probably written like <code>[Section](pytkdocs.parsers.docstrings.Section)</code> in the docs, when it should be <code>[Section][pytkdocs.parsers.docstrings.Section]</code>.</p> <h2 id=some-objects-are-not-rendered-they-do-not-appear-in-the-generated-docs>Some objects are not rendered (they do not appear in the generated docs)<a class=headerlink href=#some-objects-are-not-rendered-they-do-not-appear-in-the-generated-docs title="Permanent link">¤</a></h2> <ul> <li>Make sure the configuration options of the handler are correct. Check the documentation for <a href=../usage/handlers/ >Handlers</a> to see the available options for each handler.</li> <li>Also make sure your documentation in your source code is formatted correctly. For Python code, check the <a href=https://mkdocstrings.github.io/python/usage/#supported-docstrings-styles>supported docstring styles</a> page.</li> <li>Re-run the Mkdocs command with <code>-v</code>, and carefully read any traceback.</li> </ul> <h2 id=tabs-in-docstrings-from-pymdownxtabbed-are-not-working-properly>Tabs in docstrings (from <code>pymdownx.tabbed</code>) are not working properly<a class=headerlink href=#tabs-in-docstrings-from-pymdownxtabbed-are-not-working-properly title="Permanent link">¤</a></h2> <p>Before version 0.14, multiple tab blocks injected on the same page would result in broken links: clicking on a tab would bring the user to the wrong one. Please upgrade to version 0.14 or higher.</p> <p>See also:</p> <ul> <li><a href=https://github.com/mkdocstrings/mkdocstrings/issues/193>Issue #193</a></li> <li><a href=#footnotes-are-duplicated-or-overridden>Footnotes are duplicated or overridden</a>.</li> </ul> <p>If you are stuck on a version before 0.14, and want to use multiple tab blocks in one page, use this workaround.</p> <details class=example> <summary>JavaScript workaround</summary> <p>Put the following code in a .js file, and list it in MkDocs' <code>extra_javascript</code>:</p> <div class="language-javascript highlight"><pre><span></span><code><span class=c1>// Credits to Nikolaos Zioulis (@zuru on GitHub)</span>
<span class=kd>function</span><span class=w> </span><span class=nx>setID</span><span class=p>(){</span>
<span class=w> </span><span class=kd>var</span><span class=w> </span><span class=nx>tabs</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nb>document</span><span class=p>.</span><span class=nx>getElementsByClassName</span><span class=p>(</span><span class=s2>"tabbed-set"</span><span class=p>);</span>
<span class=w> </span><span class=k>for</span><span class=w> </span><span class=p>(</span><span class=kd>var</span><span class=w> </span><span class=nx>i</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0</span><span class=p>;</span><span class=w> </span><span class=nx>i</span><span class=w> </span><span class=o><</span><span class=w> </span><span class=nx>tabs</span><span class=p>.</span><span class=nx>length</span><span class=p>;</span><span class=w> </span><span class=nx>i</span><span class=o>++</span><span class=p>)</span><span class=w> </span><span class=p>{</span>
<span class=w> </span><span class=nx>children</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nx>tabs</span><span class=p>[</span><span class=nx>i</span><span class=p>].</span><span class=nx>children</span><span class=p>;</span>
<span class=w> </span><span class=kd>var</span><span class=w> </span><span class=nx>counter</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0</span><span class=p>;</span>
<span class=w> </span><span class=kd>var</span><span class=w> </span><span class=nx>iscontent</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0</span><span class=p>;</span>
<span class=w> </span><span class=k>for</span><span class=p>(</span><span class=kd>var</span><span class=w> </span><span class=nx>j</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0</span><span class=p>;</span><span class=w> </span><span class=nx>j</span><span class=w> </span><span class=o><</span><span class=w> </span><span class=nx>children</span><span class=p>.</span><span class=nx>length</span><span class=p>;</span><span class=nx>j</span><span class=o>++</span><span class=p>){</span>
<span class=w> </span><span class=k>if</span><span class=p>(</span><span class=ow>typeof</span><span class=w> </span><span class=nx>children</span><span class=p>[</span><span class=nx>j</span><span class=p>].</span><span class=nx>htmlFor</span><span class=w> </span><span class=o>===</span><span class=w> </span><span class=s1>'undefined'</span><span class=p>){</span>
<span class=w> </span><span class=k>if</span><span class=p>((</span><span class=nx>iscontent</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=mf>1</span><span class=p>)</span><span class=w> </span><span class=o>%</span><span class=w> </span><span class=mf>2</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=mf>0</span><span class=p>){</span>
<span class=w> </span><span class=c1>// check if it is content</span>
<span class=w> </span><span class=k>if</span><span class=p>(</span><span class=nx>iscontent</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=mf>1</span><span class=p>){</span>
<span class=w> </span><span class=nx>btn</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=nx>children</span><span class=p>[</span><span class=nx>j</span><span class=p>].</span><span class=nx>childNodes</span><span class=p>[</span><span class=mf>1</span><span class=p>].</span><span class=nx>getElementsByTagName</span><span class=p>(</span><span class=s2>"button"</span><span class=p>);</span>
<span class=w> </span><span class=p>}</span>
<span class=w> </span><span class=p>}</span>
<span class=w> </span><span class=k>else</span><span class=p>{</span>
<span class=w> </span><span class=c1>// if not change the id</span>
<span class=w> </span><span class=nx>children</span><span class=p>[</span><span class=nx>j</span><span class=p>].</span><span class=nx>id</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"__tabbed_"</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=nb>String</span><span class=p>(</span><span class=nx>i</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=mf>1</span><span class=p>)</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=s2>"_"</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=nb>String</span><span class=p>(</span><span class=nx>counter</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=mf>1</span><span class=p>);</span>
<span class=w> </span><span class=nx>children</span><span class=p>[</span><span class=nx>j</span><span class=p>].</span><span class=nx>name</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"__tabbed_"</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=nb>String</span><span class=p>(</span><span class=nx>i</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=mf>1</span><span class=p>);</span>
<span class=w> </span><span class=c1>// make default tab open</span>
<span class=w> </span><span class=k>if</span><span class=p>(</span><span class=nx>j</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=mf>0</span><span class=p>)</span>
<span class=w> </span><span class=nx>children</span><span class=p>[</span><span class=nx>j</span><span class=p>].</span><span class=nx>click</span><span class=p>();</span>
<span class=w> </span><span class=p>}</span>
<span class=w> </span><span class=nx>iscontent</span><span class=o>++</span><span class=p>;</span>
<span class=w> </span><span class=p>}</span>
<span class=w> </span><span class=k>else</span><span class=p>{</span>
<span class=w> </span><span class=c1>// link to the correct tab</span>
<span class=w> </span><span class=nx>children</span><span class=p>[</span><span class=nx>j</span><span class=p>].</span><span class=nx>htmlFor</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"__tabbed_"</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=nb>String</span><span class=p>(</span><span class=nx>i</span><span class=o>+</span><span class=mf>1</span><span class=p>)</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=s2>"_"</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=nb>String</span><span class=p>(</span><span class=nx>counter</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=mf>1</span><span class=p>);</span>
<span class=w> </span><span class=nx>counter</span><span class=w> </span><span class=o>++</span><span class=p>;</span>
<span class=w> </span><span class=p>}</span>
<span class=w> </span><span class=p>}</span>
<span class=w> </span><span class=p>}</span>
<span class=p>}</span>
<span class=nx>setID</span><span class=p>();</span>
</code></pre></div> <p>This code will correctly reset the IDs for tabs on a same page.</p> </details> <h2 id=the-generated-documentation-does-not-look-good>The generated documentation does not look good<a class=headerlink href=#the-generated-documentation-does-not-look-good title="Permanent link">¤</a></h2> <p>Please open an ticket on the <a href=https://github.com/mkdocstrings/mkdocstrings>bugtracker</a> with a detailed explanation and screenshots of the bad-looking parts. Note that you can always <a href=../usage/theming/ >customize the look</a> of <em>mkdocstrings</em> blocks -- through both HTML and CSS.</p> <h2 id=warning-could-not-find-cross-reference-target>Warning: could not find cross-reference target<a class=headerlink href=#warning-could-not-find-cross-reference-target title="Permanent link">¤</a></h2> <div class="admonition tip"> <p class=admonition-title>New in version 0.15.</p> <p>Cross-linking used to include any Markdown heading, but now it's only for <em>mkdocstrings</em> identifiers by default. See <a href=../usage/#cross-references-to-any-markdown-heading>Cross-references to any Markdown heading</a> to opt back in.</p> </div> <p>Make sure the referenced object is properly rendered: verify your configuration options.</p> <p>For false-positives, you can wrap the text in backticks (`) to prevent <code>mkdocstrings</code> from trying to process it.</p> <hr> <h2 id=python-specifics>Python specifics<a class=headerlink href=#python-specifics title="Permanent link">¤</a></h2> <h3 id=nothing-is-rendered-at-all>Nothing is rendered at all<a class=headerlink href=#nothing-is-rendered-at-all title="Permanent link">¤</a></h3> <p>Is your package available in the Python path?</p> <p>See <a href=https://mkdocstrings.github.io/python/usage/#finding-modules>Python handler: Finding modules</a>.</p> <h3 id=latex-in-docstrings-is-not-rendered-correctly>LaTeX in docstrings is not rendered correctly<a class=headerlink href=#latex-in-docstrings-is-not-rendered-correctly title="Permanent link">¤</a></h3> <p>If you are using a Markdown extension like <a href=https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#arithmatex>Arithmatex Mathjax</a> or <a href=https://gitlab.com/mbarkhau/markdown-katex><code>markdown-katex</code></a> to render LaTeX, add <code>r</code> in front of your docstring to make sure nothing is escaped. You'll still maybe have to play with escaping to get things right.</p> <p>Example:</p> <div class="language-python highlight"><pre><span></span><code><span class=k>def</span><span class=w> </span><span class=nf>math_function</span><span class=p>(</span><span class=n>x</span><span class=p>,</span> <span class=n>y</span><span class=p>):</span>
<span class=w> </span><span class=sa>r</span><span class=sd>"""</span>
<span class=sd> Look at these formulas:</span>
<span class=sd> ```math</span>
<span class=sd> f(x) = \int_{-\infty}^\infty</span>
<span class=sd> \hat f(\xi)\,e^{2 \pi i \xi x}</span>
<span class=sd> \,d\xi</span>
<span class=sd> ```</span>
<span class=sd> """</span>
</code></pre></div> <h3 id=my-docstrings-in-comments-are-not-picked-up>My docstrings in comments (<code>#:</code>) are not picked up<a class=headerlink href=#my-docstrings-in-comments-are-not-picked-up title="Permanent link">¤</a></h3> <p>We only support docstrings in comments through the <a href=https://mkdocstrings.github.io/griffe-sphinx>griffe-sphinx</a> extension.</p> <p>Alternatively, instead of:</p> <div class="language-python highlight"><pre><span></span><code><span class=kn>import</span><span class=w> </span><span class=nn>enum</span>
<span class=k>class</span><span class=w> </span><span class=nc>MyEnum</span><span class=p>(</span><span class=n>enum</span><span class=o>.</span><span class=n>Enum</span><span class=p>):</span>
<span class=n>v1</span> <span class=o>=</span> <span class=mi>1</span> <span class=c1>#: The first choice.</span>
<span class=n>v2</span> <span class=o>=</span> <span class=mi>2</span> <span class=c1>#: The second choice.</span>
</code></pre></div> <p>You can use:</p> <div class="language-python highlight"><pre><span></span><code><span class=kn>import</span><span class=w> </span><span class=nn>enum</span>
<span class=k>class</span><span class=w> </span><span class=nc>MyEnum</span><span class=p>(</span><span class=n>enum</span><span class=o>.</span><span class=n>Enum</span><span class=p>):</span>
<span class=n>v1</span> <span class=o>=</span> <span class=mi>1</span>
<span class=w> </span><span class=sd>"""The first choice."""</span>
<span class=n>v2</span> <span class=o>=</span> <span class=mi>2</span>
<span class=w> </span><span class=sd>"""The second choice."""</span>
</code></pre></div> <p>Or:</p> <div class="language-python highlight"><pre><span></span><code><span class=kn>import</span><span class=w> </span><span class=nn>enum</span>
<span class=k>class</span><span class=w> </span><span class=nc>MyEnum</span><span class=p>(</span><span class=n>enum</span><span class=o>.</span><span class=n>Enum</span><span class=p>):</span>
<span class=w> </span><span class=sd>"""My enum.</span>
<span class=sd> Attributes:</span>
<span class=sd> v1: The first choice.</span>
<span class=sd> v2: The second choice.</span>
<span class=sd> """</span>
<span class=n>v1</span> <span class=o>=</span> <span class=mi>1</span>
<span class=n>v2</span> <span class=o>=</span> <span class=mi>2</span>
</code></pre></div> <h3 id=my-wrapped-function-shows-documentationcode-for-its-wrapper-instead-of-its-own>My wrapped function shows documentation/code for its wrapper instead of its own<a class=headerlink href=#my-wrapped-function-shows-documentationcode-for-its-wrapper-instead-of-its-own title="Permanent link">¤</a></h3> <p>Use <a href=https://docs.python.org/3.6/library/functools.html#functools.wraps><code>functools.wraps()</code></a>:</p> <div class="language-python highlight"><pre><span></span><code><span class=kn>from</span><span class=w> </span><span class=nn>functools</span><span class=w> </span><span class=kn>import</span> <span class=n>wraps</span>
<span class=k>def</span><span class=w> </span><span class=nf>my_decorator</span><span class=p>(</span><span class=n>function</span><span class=p>):</span>
<span class=w> </span><span class=sd>"""The decorator docs."""</span>
<span class=nd>@wraps</span><span class=p>(</span><span class=n>function</span><span class=p>)</span>
<span class=k>def</span><span class=w> </span><span class=nf>wrapped_function</span><span class=p>(</span><span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
<span class=nb>print</span><span class=p>(</span><span class=s2>"hello"</span><span class=p>)</span>
<span class=n>function</span><span class=p>(</span><span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
<span class=nb>print</span><span class=p>(</span><span class=s2>"bye"</span><span class=p>)</span>
<span class=k>return</span> <span class=n>wrapped_function</span>
<span class=nd>@my_decorator</span>
<span class=k>def</span><span class=w> </span><span class=nf>my_function</span><span class=p>(</span><span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
<span class=w> </span><span class=sd>"""The function docs."""</span>
<span class=nb>print</span><span class=p>(</span><span class=o>*</span><span class=n>args</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
</code></pre></div> <h3 id=footnotes-do-not-render>Footnotes do not render<a class=headerlink href=#footnotes-do-not-render title="Permanent link">¤</a></h3> <p>The library that parses docstrings, <a href=https://mkdocstrings.github.io/griffe/ >Griffe</a>, splits docstrings in several "sections" (example: <a href=https://mkdocstrings.github.io/griffe/reference/docstrings/#google-syntax>Google-style sections syntax</a>). If a footnote is used in a section, while referenced in another, mkdocstrings won't be able to render it correctly. The footnote and its reference must appear in the same section.</p> <div class="language-python highlight"><pre><span></span><code><span class=k>def</span><span class=w> </span><span class=nf>my_function</span><span class=p>():</span>
<span class=w> </span><span class=sd>"""Summary.</span>
<span class=sd> This is the first section[^1].</span>
<span class=sd> Note:</span>
<span class=sd> This is the second section[^2].</span>
<span class=sd> Note:</span>
<span class=sd> This is the third section[^3].</span>
<span class=sd> References at the end are part of yet another section (fourth here)[^4].</span>
<span class=sd> [^1]: Some text.</span>
<span class=sd> [^2]: Some text.</span>
<span class=sd> [^3]: Some text.</span>
<span class=sd> [^4]: Some text.</span>
<span class=sd> """</span>
</code></pre></div> <p>Here only the fourth footnote will work, because it is the only one that appear in the same section as its reference. To fix this, make sure all footnotes appear in the same section as their references:</p> <div class="language-python highlight"><pre><span></span><code><span class=k>def</span><span class=w> </span><span class=nf>my_function</span><span class=p>():</span>
<span class=w> </span><span class=sd>"""Summary.</span>
<span class=sd> This is the first section[^1].</span>
<span class=sd> [^1]: Some text.</span>
<span class=sd> Note:</span>
<span class=sd> This is the second section[^2].</span>
<span class=sd> [^2]: Some text.</span>
<span class=sd> Note:</span>
<span class=sd> This is the third section[^3].</span>
<span class=sd> [^3]: Some text.</span>
<span class=sd> References at the end are part of yet another section (fourth here)[^4].</span>
<span class=sd> [^4]: Some text.</span>
<span class=sd> """</span>
</code></pre></div> <h3 id=submodules-are-not-rendered>Submodules are not rendered<a class=headerlink href=#submodules-are-not-rendered title="Permanent link">¤</a></h3> <p>In previous versions of mkdocstrings-python, submodules were rendered by default. This was changed and you now need to set the following option:</p> <div class="language-yaml highlight"><span class=filename>mkdocs.yml</span><pre><span></span><code><span class=nt>plugins</span><span class=p>:</span>
<span class="p p-Indicator">-</span><span class=w> </span><span class=nt>mkdocstrings</span><span class=p>:</span>
<span class=w> </span><span class=nt>handlers</span><span class=p>:</span>
<span class=w> </span><span class=nt>python</span><span class=p>:</span>
<span class=w> </span><span class=nt>options</span><span class=p>:</span>
<span class=w> </span><span class=nt>show_submodules</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</code></pre></div> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 14, 2025 12:30:32"><span class=timeago datetime=2025-01-14T12:30:32+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 14, 2025 12:30:32">2025-01-14</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 14, 2025 12:30:32"><span class=timeago datetime=2025-01-14T12:30:32+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 14, 2025 12:30:32">2025-01-14</span> </span> </aside> <form class=md-feedback name=feedback hidden> <fieldset> <legend class=md-feedback__title> Was this page helpful? </legend> <div class=md-feedback__inner> <div class=md-feedback__list> <button class="md-feedback__icon md-icon" type=submit title="This page was helpful" data-md-value=1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg> </button> <button class="md-feedback__icon md-icon" type=submit title="This page could be improved" data-md-value=0> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"/></svg> </button> </div> <div class=md-feedback__note> <div data-md-value=1 hidden> Thanks for your feedback! </div> <div data-md-value=0 hidden> Let us know how we can improve this page. </div> </div> </div> </fieldset> </form> <!-- Giscus --> <!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration --> <div id=feedback style="display: none;"> <h2 id=__comments>Feedback</h2> <script src=https://giscus.app/client.js data-repo=mkdocstrings/mkdocstrings data-repo-id="MDEwOlJlcG9zaXRvcnkyMjY5MzY0MTY=" data-category=Documentation data-category-id=DIC_kwDODYbGYM4ChKXy data-mapping=pathname data-strict=1 data-reactions-enabled=0 data-emit-metadata=0 data-input-position=top data-theme=preferred_color_scheme data-lang=en data-loading=lazy crossorigin=anonymous async>
</script> <!-- Synchronize Giscus theme with palette --> <script>
var giscus = document.querySelector("script[src*=giscus]")
// Set palette on initial load
var palette = __md_get("__palette")
if (palette && typeof palette.color === "object") {
var theme = palette.color.scheme === "slate"
? "transparent_dark"
: "light"
// Instruct Giscus to set theme
giscus.setAttribute("data-theme", theme)
}
// Register event handlers after documented loaded
document.addEventListener("DOMContentLoaded", function() {
var ref = document.querySelector("[data-md-component=palette]")
ref.addEventListener("change", function() {
var palette = __md_get("__palette")
if (palette && typeof palette.color === "object") {
var theme = palette.color.scheme === "slate"
? "transparent_dark"
: "light"
// Instruct Giscus to change theme
var frame = document.querySelector(".giscus-frame")
frame.contentWindow.postMessage(
{ giscus: { setConfig: { theme } } },
"https://giscus.app"
)
}
})
})
</script> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../recipes/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Recipes"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Recipes </div> </div> </a> <a href=../reference/mkdocstrings/ class="md-footer__link md-footer__link--next" aria-label="Next: API reference"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> API reference </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright © 2019 Timothée Mazzucotelli </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs Insiders </a> </div> <div class=md-social> <a href=https://github.com/pawamoy target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> <a href=https://fosstodon.org/@pawamoy target=_blank rel="noopener me" title=fosstodon.org class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M433 179.11c0-97.2-63.71-125.7-63.71-125.7-62.52-28.7-228.56-28.4-290.48 0 0 0-63.72 28.5-63.72 125.7 0 115.7-6.6 259.4 105.63 289.1 40.51 10.7 75.32 13 103.33 11.4 50.81-2.8 79.32-18.1 79.32-18.1l-1.7-36.9s-36.31 11.4-77.12 10.1c-40.41-1.4-83-4.4-89.63-54a102.5 102.5 0 0 1-.9-13.9c85.63 20.9 158.65 9.1 178.75 6.7 56.12-6.7 105-41.3 111.23-72.9 9.8-49.8 9-121.5 9-121.5m-75.12 125.2h-46.63v-114.2c0-49.7-64-51.6-64 6.9v62.5h-46.33V197c0-58.5-64-56.6-64-6.9v114.2H90.19c0-122.1-5.2-147.9 18.41-175 25.9-28.9 79.82-30.8 103.83 6.1l11.6 19.5 11.6-19.5c24.11-37.1 78.12-34.8 103.83-6.1 23.71 27.3 18.4 53 18.4 175z"/></svg> </a> <a href=https://twitter.com/pawamoy target=_blank rel=noopener title=twitter.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253"/></svg> </a> <a href=https://gitter.im/mkdocstrings/community target=_blank rel=noopener title=gitter.im class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 384 512"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M66.4 322.5H16V0h50.4zM166.9 76.1h-50.4V512h50.4zm100.6 0h-50.4V512h50.4zM368 76h-50.4v247H368z"/></svg> </a> <a href=https://pypi.org/project/mkdocstrings/ target=_blank rel=noopener title=pypi.org class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6M286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3M167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4m-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "..", "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"], "search": "../assets/javascripts/workers/search.c7c1ca2c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=../assets/javascripts/bundle.f807c082.min.js></script> <script src=../assets/_markdown_exec_pyodide.js></script> <script src=../js/timeago.min.js></script> <script src=../js/timeago_mkdocs_material.js></script> <script src=../js/feedback.js></script> </body> </html>