Skip to content

Commit 30fd8f8

Browse files
pawamoypawamoy
committed
Deployed 61c1666 with MkDocs version: 1.2.3
1 parent 7410669 commit 30fd8f8

13 files changed

Lines changed: 395 additions & 343 deletions

File tree

‎changelog/index.html‎

Lines changed: 118 additions & 72 deletions
Large diffs are not rendered by default.

‎coverage/covindex.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<header>
1212
<div class="content">
1313
<h1>Coverage report:
14-
<span class="pc_cov">87.26%</span>
14+
<span class="pc_cov">87.28%</span>
1515
</h1>
1616
<div id="help_panel_wrapper">
1717
<input id="help_panel_state" type="checkbox">
@@ -54,12 +54,12 @@ <h1>Coverage report:
5454
<tbody>
5555
<tr class="file">
5656
<td class="name left"><a href="d_7c5e48b88f50e873_extension_py.html">src/mkdocstrings/extension.py</a></td>
57-
<td>112</td>
57+
<td>110</td>
5858
<td>13</td>
5959
<td>0</td>
60-
<td>34</td>
60+
<td>32</td>
6161
<td>4</td>
62-
<td class="right" data-ratio="127 146">86.99%</td>
62+
<td class="right" data-ratio="123 142">86.62%</td>
6363
</tr>
6464
<tr class="file">
6565
<td class="name left"><a href="d_fca87304f13ef3fa_base_py.html">src/mkdocstrings/handlers/base.py</a></td>
@@ -90,12 +90,12 @@ <h1>Coverage report:
9090
</tr>
9191
<tr class="file">
9292
<td class="name left"><a href="d_7c5e48b88f50e873_loggers_py.html">src/mkdocstrings/loggers.py</a></td>
93-
<td>44</td>
93+
<td>45</td>
9494
<td>4</td>
9595
<td>0</td>
9696
<td>6</td>
9797
<td>1</td>
98-
<td class="right" data-ratio="45 50">90.00%</td>
98+
<td class="right" data-ratio="46 51">90.20%</td>
9999
</tr>
100100
<tr class="file">
101101
<td class="name left"><a href="d_7c5e48b88f50e873_plugin_py.html">src/mkdocstrings/plugin.py</a></td>
@@ -180,12 +180,12 @@ <h1>Coverage report:
180180
</tr>
181181
<tr class="file">
182182
<td class="name left"><a href="d_a44f0ac069e85531_test_extension_py.html">tests/test_extension.py</a></td>
183-
<td>41</td>
184-
<td>0</td>
183+
<td>50</td>
185184
<td>0</td>
186185
<td>0</td>
187-
<td>0</td>
188-
<td class="right" data-ratio="41 41">100.00%</td>
186+
<td>4</td>
187+
<td>1</td>
188+
<td class="right" data-ratio="53 54">98.15%</td>
189189
</tr>
190190
<tr class="file">
191191
<td class="name left"><a href="d_a44f0ac069e85531_test_handlers_py.html">tests/test_handlers.py</a></td>
@@ -209,12 +209,12 @@ <h1>Coverage report:
209209
<tfoot>
210210
<tr class="total">
211211
<td class="name left">Total</td>
212-
<td>730</td>
212+
<td>738</td>
213213
<td>68</td>
214214
<td>0</td>
215-
<td>243</td>
216-
<td>36</td>
217-
<td class="right" data-ratio="849 973">87.26%</td>
215+
<td>245</td>
216+
<td>37</td>
217+
<td class="right" data-ratio="858 983">87.28%</td>
218218
</tr>
219219
</tfoot>
220220
</table>
@@ -226,7 +226,7 @@ <h1>Coverage report:
226226
<div class="content">
227227
<p>
228228
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.3.2</a>,
229-
created at 2022-02-22 23:38 +0100
229+
created at 2022-03-01 19:17 +0100
230230
</p>
231231
</div>
232232
</footer>

‎coverage/d_7c5e48b88f50e873_extension_py.html‎

Lines changed: 147 additions & 150 deletions
Large diffs are not rendered by default.

‎coverage/d_7c5e48b88f50e873_loggers_py.html‎

Lines changed: 34 additions & 33 deletions
Large diffs are not rendered by default.

‎coverage/d_a44f0ac069e85531_test_extension_py.html‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=emulateIE7" />
6-
<title>Coverage for tests/test_extension.py: 100.00%</title>
6+
<title>Coverage for tests/test_extension.py: 98.15%</title>
77
<link rel="icon" sizes="32x32" href="favicon_32.png">
88
<link rel="stylesheet" href="style.css" type="text/css">
99
<script type="text/javascript" src="coverage_html.js" defer></script>
@@ -13,7 +13,7 @@
1313
<div class="content">
1414
<h1>
1515
<span class="text">Coverage for </span><b>tests/test_extension.py</b>:
16-
<span class="pc_cov">100.00%</span>
16+
<span class="pc_cov">98.15%</span>
1717
</h1>
1818
<div id="help_panel_wrapper">
1919
<input id="help_panel_state" type="checkbox">
@@ -44,11 +44,11 @@ <h1>
4444
</div>
4545
</div>
4646
<h2>
47-
<span class="text">41 statements &nbsp;</span>
48-
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">41<span class="text"> run</span></button>
47+
<span class="text">50 statements &nbsp;</span>
48+
<button type="button" class="run button_toggle_run" value="run" data-shortcut="r" title="Toggle lines run">50<span class="text"> run</span></button>
4949
<button type="button" class="mis show_mis button_toggle_mis" value="mis" data-shortcut="m" title="Toggle lines missing">0<span class="text"> missing</span></button>
5050
<button type="button" class="exc show_exc button_toggle_exc" value="exc" data-shortcut="x" title="Toggle lines excluded">0<span class="text"> excluded</span></button>
51-
<button type="button" class="par run show_par button_toggle_par" value="par" data-shortcut="p" title="Toggle lines partially run">0<span class="text"> partial</span></button>
51+
<button type="button" class="par run show_par button_toggle_par" value="par" data-shortcut="p" title="Toggle lines partially run">1<span class="text"> partial</span></button>
5252
</h2>
5353
<div style="display: none;">
5454
<button type="button" class="button_next_chunk" data-shortcut="j">Next highlighted chunk</button>
@@ -184,12 +184,24 @@ <h2>
184184
<p class="pln"><span class="n"><a id="t123" href="#t123">123</a></span><span class="t"> <span class="str">"""Assert that we use the custom handler declared in an individual autodoc instruction."""</span>&nbsp;</span><span class="r"></span></p>
185185
<p class="run"><span class="n"><a id="t124" href="#t124">124</a></span><span class="t"> <span class="key">with</span> <span class="nam">pytest</span><span class="op">.</span><span class="nam">raises</span><span class="op">(</span><span class="nam">ModuleNotFoundError</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
186186
<p class="run"><span class="n"><a id="t125" href="#t125">125</a></span><span class="t"> <span class="nam">ext_markdown</span><span class="op">.</span><span class="nam">convert</span><span class="op">(</span><span class="str">"::: tests.fixtures.headings\n handler: not_here"</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
187+
<p class="pln"><span class="n"><a id="t126" href="#t126">126</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
188+
<p class="pln"><span class="n"><a id="t127" href="#t127">127</a></span><span class="t">&nbsp;</span><span class="r"></span></p>
189+
<p class="run"><span class="n"><a id="t128" href="#t128">128</a></span><span class="t"><span class="key">def</span> <span class="nam">test_dont_register_every_identifier_as_anchor</span><span class="op">(</span><span class="nam">plugin</span><span class="op">)</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
190+
<p class="pln"><span class="n"><a id="t129" href="#t129">129</a></span><span class="t"> <span class="str">"""Assert that we don't preemptively register all identifiers of a rendered object."""</span>&nbsp;</span><span class="r"></span></p>
191+
<p class="run"><span class="n"><a id="t130" href="#t130">130</a></span><span class="t"> <span class="nam">renderer</span> <span class="op">=</span> <span class="nam">plugin</span><span class="op">.</span><span class="nam">_handlers</span><span class="op">.</span><span class="nam">get_handler</span><span class="op">(</span><span class="str">"python"</span><span class="op">)</span><span class="op">.</span><span class="nam">renderer</span> <span class="com"># noqa: WPS437</span>&nbsp;</span><span class="r"></span></p>
192+
<p class="run"><span class="n"><a id="t131" href="#t131">131</a></span><span class="t"> <span class="nam">ids</span> <span class="op">=</span> <span class="op">{</span><span class="str">"id1"</span><span class="op">,</span> <span class="str">"id2"</span><span class="op">,</span> <span class="str">"id3"</span><span class="op">}</span>&nbsp;</span><span class="r"></span></p>
193+
<p class="par run show_par"><span class="n"><a id="t132" href="#t132">132</a></span><span class="t"> <span class="nam">renderer</span><span class="op">.</span><span class="nam">get_anchors</span> <span class="op">=</span> <span class="key">lambda</span> <span class="nam">_</span><span class="op">:</span> <span class="nam">ids</span>&nbsp;</span><span class="r"><span class="annotate short">132&#x202F;&#x219B;&#x202F;exit</span><span class="annotate long">line 132 didn't run the lambda on line 132</span></span></p>
194+
<p class="run"><span class="n"><a id="t133" href="#t133">133</a></span><span class="t"> <span class="nam">plugin</span><span class="op">.</span><span class="nam">md</span><span class="op">.</span><span class="nam">convert</span><span class="op">(</span><span class="str">"::: tests.fixtures.headings"</span><span class="op">)</span>&nbsp;</span><span class="r"></span></p>
195+
<p class="run"><span class="n"><a id="t134" href="#t134">134</a></span><span class="t"> <span class="nam">autorefs</span> <span class="op">=</span> <span class="nam">plugin</span><span class="op">.</span><span class="nam">md</span><span class="op">.</span><span class="nam">parser</span><span class="op">.</span><span class="nam">blockprocessors</span><span class="op">[</span><span class="str">"mkdocstrings"</span><span class="op">]</span><span class="op">.</span><span class="nam">_autorefs</span> <span class="com"># noqa: WPS219,WPS437</span>&nbsp;</span><span class="r"></span></p>
196+
<p class="run"><span class="n"><a id="t135" href="#t135">135</a></span><span class="t"> <span class="key">for</span> <span class="nam">identifier</span> <span class="key">in</span> <span class="nam">ids</span><span class="op">:</span>&nbsp;</span><span class="r"></span></p>
197+
<p class="run"><span class="n"><a id="t136" href="#t136">136</a></span><span class="t"> <span class="key">assert</span> <span class="nam">identifier</span> <span class="key">not</span> <span class="key">in</span> <span class="nam">autorefs</span><span class="op">.</span><span class="nam">_url_map</span> <span class="com"># noqa: WPS437</span>&nbsp;</span><span class="r"></span></p>
198+
<p class="run"><span class="n"><a id="t137" href="#t137">137</a></span><span class="t"> <span class="key">assert</span> <span class="nam">identifier</span> <span class="key">not</span> <span class="key">in</span> <span class="nam">autorefs</span><span class="op">.</span><span class="nam">_abs_url_map</span> <span class="com"># noqa: WPS437</span>&nbsp;</span><span class="r"></span></p>
187199
</main>
188200
<footer>
189201
<div class="content">
190202
<p>
191203
<a class="nav" href="covindex.html">&#xab; index</a> &nbsp; &nbsp; <a class="nav" href="https://coverage.readthedocs.io">coverage.py v6.3.2</a>,
192-
created at 2022-02-22 23:38 +0100
204+
created at 2022-02-26 13:42 +0100
193205
</p>
194206
</div>
195207
</footer>

‎coverage/status.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"format":2,"version":"6.3.2","globals":"20dc886b7700d42460bd3bf40056059a","files":{"d_7c5e48b88f50e873_extension_py":{"hash":"b35d3c22f9c75311d8da51265db47eeb","index":{"nums":[2,1,112,0,13,34,4,6],"html_filename":"d_7c5e48b88f50e873_extension_py.html","relative_filename":"src/mkdocstrings/extension.py"}},"d_fca87304f13ef3fa_base_py":{"hash":"8dfdbf6deea79b32f6546e81adca1faa","index":{"nums":[2,1,168,0,21,68,11,23],"html_filename":"d_fca87304f13ef3fa_base_py.html","relative_filename":"src/mkdocstrings/handlers/base.py"}},"d_fca87304f13ef3fa_rendering_py":{"hash":"46b7054f52af0393472af4f41913a154","index":{"nums":[2,1,109,0,8,56,6,8],"html_filename":"d_fca87304f13ef3fa_rendering_py.html","relative_filename":"src/mkdocstrings/handlers/rendering.py"}},"d_7c5e48b88f50e873_inventory_py":{"hash":"6ae473f241c5dec366034b070486b666","index":{"nums":[2,1,56,0,1,26,3,3],"html_filename":"d_7c5e48b88f50e873_inventory_py.html","relative_filename":"src/mkdocstrings/inventory.py"}},"d_7c5e48b88f50e873_loggers_py":{"hash":"9f32d9227c7a45995dd19623aa2b9d83","index":{"nums":[2,1,44,0,4,6,1,1],"html_filename":"d_7c5e48b88f50e873_loggers_py.html","relative_filename":"src/mkdocstrings/loggers.py"}},"d_7c5e48b88f50e873_plugin_py":{"hash":"136903989b473ad2517cf65e5a16fad4","index":{"nums":[2,1,110,0,8,39,11,13],"html_filename":"d_7c5e48b88f50e873_plugin_py.html","relative_filename":"src/mkdocstrings/plugin.py"}},"d_a44f0ac069e85531_conftest_py":{"hash":"f99aeb2c7d73ffbb856cb48d236f8509","index":{"nums":[2,1,32,0,3,2,0,0],"html_filename":"d_a44f0ac069e85531_conftest_py.html","relative_filename":"tests/conftest.py"}},"d_002c493ad4b8202f___init___py":{"hash":"39da4cf14d3f50890dd087f488cb60b2","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_002c493ad4b8202f___init___py.html","relative_filename":"tests/fixtures/__init__.py"}},"d_002c493ad4b8202f_builtin_py":{"hash":"62cdc0755e60e2868b2aadd02fc9a0b1","index":{"nums":[2,1,1,0,1,0,0,0],"html_filename":"d_002c493ad4b8202f_builtin_py.html","relative_filename":"tests/fixtures/builtin.py"}},"d_002c493ad4b8202f_cross_reference_py":{"hash":"bc83d1be1342f56e7bab70aa1220cf47","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_002c493ad4b8202f_cross_reference_py.html","relative_filename":"tests/fixtures/cross_reference.py"}},"d_002c493ad4b8202f_footnotes_py":{"hash":"1ef60c35969adbf744d7455434e3ec2d","index":{"nums":[2,1,3,0,3,0,0,0],"html_filename":"d_002c493ad4b8202f_footnotes_py.html","relative_filename":"tests/fixtures/footnotes.py"}},"d_002c493ad4b8202f_headings_py":{"hash":"56630f600091a849a3591249bd45fb71","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_002c493ad4b8202f_headings_py.html","relative_filename":"tests/fixtures/headings.py"}},"d_002c493ad4b8202f_html_tokens_py":{"hash":"577b0451f6be1ba6921e8d99e21537b0","index":{"nums":[2,1,1,0,1,0,0,0],"html_filename":"d_002c493ad4b8202f_html_tokens_py.html","relative_filename":"tests/fixtures/html_tokens.py"}},"d_002c493ad4b8202f_string_annotation_py":{"hash":"bb11c3305c44d97a42ec22e7db96ab4a","index":{"nums":[2,1,5,0,5,2,0,2],"html_filename":"d_002c493ad4b8202f_string_annotation_py.html","relative_filename":"tests/fixtures/string_annotation.py"}},"d_a44f0ac069e85531_test_extension_py":{"hash":"ae2b6b1ba24a212e975bf8e9a96f49be","index":{"nums":[2,1,41,0,0,0,0,0],"html_filename":"d_a44f0ac069e85531_test_extension_py.html","relative_filename":"tests/test_extension.py"}},"d_a44f0ac069e85531_test_handlers_py":{"hash":"59f65c535991046512cdf9e7053ffed4","index":{"nums":[2,1,21,0,0,2,0,0],"html_filename":"d_a44f0ac069e85531_test_handlers_py.html","relative_filename":"tests/test_handlers.py"}},"d_a44f0ac069e85531_test_inventory_py":{"hash":"f9ab3acc6051ebdfc8a1d08a673beb72","index":{"nums":[2,1,27,0,0,8,0,0],"html_filename":"d_a44f0ac069e85531_test_inventory_py.html","relative_filename":"tests/test_inventory.py"}}}}
1+
{"format":2,"version":"6.3.2","globals":"20dc886b7700d42460bd3bf40056059a","files":{"d_7c5e48b88f50e873_extension_py":{"hash":"092abed014deeaefd637350600e63081","index":{"nums":[2,1,110,0,13,32,4,6],"html_filename":"d_7c5e48b88f50e873_extension_py.html","relative_filename":"src/mkdocstrings/extension.py"}},"d_fca87304f13ef3fa_base_py":{"hash":"8dfdbf6deea79b32f6546e81adca1faa","index":{"nums":[2,1,168,0,21,68,11,23],"html_filename":"d_fca87304f13ef3fa_base_py.html","relative_filename":"src/mkdocstrings/handlers/base.py"}},"d_fca87304f13ef3fa_rendering_py":{"hash":"46b7054f52af0393472af4f41913a154","index":{"nums":[2,1,109,0,8,56,6,8],"html_filename":"d_fca87304f13ef3fa_rendering_py.html","relative_filename":"src/mkdocstrings/handlers/rendering.py"}},"d_7c5e48b88f50e873_inventory_py":{"hash":"6ae473f241c5dec366034b070486b666","index":{"nums":[2,1,56,0,1,26,3,3],"html_filename":"d_7c5e48b88f50e873_inventory_py.html","relative_filename":"src/mkdocstrings/inventory.py"}},"d_7c5e48b88f50e873_loggers_py":{"hash":"fb0487a338761359c1e53ecae332e7ea","index":{"nums":[2,1,45,0,4,6,1,1],"html_filename":"d_7c5e48b88f50e873_loggers_py.html","relative_filename":"src/mkdocstrings/loggers.py"}},"d_7c5e48b88f50e873_plugin_py":{"hash":"136903989b473ad2517cf65e5a16fad4","index":{"nums":[2,1,110,0,8,39,11,13],"html_filename":"d_7c5e48b88f50e873_plugin_py.html","relative_filename":"src/mkdocstrings/plugin.py"}},"d_a44f0ac069e85531_conftest_py":{"hash":"f99aeb2c7d73ffbb856cb48d236f8509","index":{"nums":[2,1,32,0,3,2,0,0],"html_filename":"d_a44f0ac069e85531_conftest_py.html","relative_filename":"tests/conftest.py"}},"d_002c493ad4b8202f___init___py":{"hash":"39da4cf14d3f50890dd087f488cb60b2","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_002c493ad4b8202f___init___py.html","relative_filename":"tests/fixtures/__init__.py"}},"d_002c493ad4b8202f_builtin_py":{"hash":"62cdc0755e60e2868b2aadd02fc9a0b1","index":{"nums":[2,1,1,0,1,0,0,0],"html_filename":"d_002c493ad4b8202f_builtin_py.html","relative_filename":"tests/fixtures/builtin.py"}},"d_002c493ad4b8202f_cross_reference_py":{"hash":"bc83d1be1342f56e7bab70aa1220cf47","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_002c493ad4b8202f_cross_reference_py.html","relative_filename":"tests/fixtures/cross_reference.py"}},"d_002c493ad4b8202f_footnotes_py":{"hash":"1ef60c35969adbf744d7455434e3ec2d","index":{"nums":[2,1,3,0,3,0,0,0],"html_filename":"d_002c493ad4b8202f_footnotes_py.html","relative_filename":"tests/fixtures/footnotes.py"}},"d_002c493ad4b8202f_headings_py":{"hash":"56630f600091a849a3591249bd45fb71","index":{"nums":[2,1,0,0,0,0,0,0],"html_filename":"d_002c493ad4b8202f_headings_py.html","relative_filename":"tests/fixtures/headings.py"}},"d_002c493ad4b8202f_html_tokens_py":{"hash":"577b0451f6be1ba6921e8d99e21537b0","index":{"nums":[2,1,1,0,1,0,0,0],"html_filename":"d_002c493ad4b8202f_html_tokens_py.html","relative_filename":"tests/fixtures/html_tokens.py"}},"d_002c493ad4b8202f_string_annotation_py":{"hash":"bb11c3305c44d97a42ec22e7db96ab4a","index":{"nums":[2,1,5,0,5,2,0,2],"html_filename":"d_002c493ad4b8202f_string_annotation_py.html","relative_filename":"tests/fixtures/string_annotation.py"}},"d_a44f0ac069e85531_test_extension_py":{"hash":"cb64519a06695e1bbc99e1f5643eea98","index":{"nums":[2,1,50,0,0,4,1,1],"html_filename":"d_a44f0ac069e85531_test_extension_py.html","relative_filename":"tests/test_extension.py"}},"d_a44f0ac069e85531_test_handlers_py":{"hash":"59f65c535991046512cdf9e7053ffed4","index":{"nums":[2,1,21,0,0,2,0,0],"html_filename":"d_a44f0ac069e85531_test_handlers_py.html","relative_filename":"tests/test_handlers.py"}},"d_a44f0ac069e85531_test_inventory_py":{"hash":"f9ab3acc6051ebdfc8a1d08a673beb72","index":{"nums":[2,1,27,0,0,8,0,0],"html_filename":"d_a44f0ac069e85531_test_inventory_py.html","relative_filename":"tests/test_inventory.py"}}}}

‎handlers/overview/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1066,8 +1066,8 @@ <h4 id="selection-options">Selection options<a class="headerlink" href="#selecti
10661066
except for the <code>restructured-text</code> style which is renamed <code>sphinx</code>.
10671067
Numpy-style is now built-in, so you can stop depending on <code>pytkdocs[numpy-style]</code>
10681068
or <code>docstring_parser</code>.</li>
1069-
<li><code>docstring_options</code> is implemented, and used as before, however none
1070-
of the provided parsers accept any option yet.</li>
1069+
<li><code>docstring_options</code> is implemented, and used as before.
1070+
Refer to the <a href="https://mkdocstrings.github.io/griffe/docstrings/#parsing-options"><code>griffe</code> documentation</a> for the updated list of supported docstring options.</li>
10711071
<li><code>new_path_syntax</code> is irrelevant now. If you were setting it to True,
10721072
remove the option and replace every colon (<code>:</code>) in your autodoc identifiers
10731073
by dots (<code>.</code>).</li>

0 commit comments

Comments
 (0)