Skip to content

Commit 6100c0a

Browse files
committed
Deployed 729d6e3 with MkDocs version: 1.6.1
1 parent 57b548e commit 6100c0a

File tree

8 files changed

+49
-30
lines changed

8 files changed

+49
-30
lines changed

changelog/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

credits/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

objects.inv

57 Bytes
Binary file not shown.

reference/mkdocstrings_handlers/python/handler/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@
8686
<span class=n><a class="autorefs autorefs-internal" href=#mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(heading_level)>heading_level</a></span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3/library/functions.html#int>int</a></span><span class=p>,</span>
8787
<span class=n><a class="autorefs autorefs-internal" href=#mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(html_id)>html_id</a></span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3/library/stdtypes.html#str>str</a></span> <span class=o>=</span> <span class=s2>&quot;&quot;</span><span class=p>,</span>
8888
<span class=o>*</span><span class=p>,</span>
89-
<span class=n><a class="autorefs autorefs-internal" href=#mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(strip_paragraph)>strip_paragraph</a></span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3/library/functions.html#bool>bool</a></span> <span class=o>=</span> <span class=kc>False</span>
89+
<span class=n><a class="autorefs autorefs-internal" href=#mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(strip_paragraph)>strip_paragraph</a></span><span class=p>:</span> <span class=n><a class="autorefs autorefs-external" href=https://docs.python.org/3/library/functions.html#bool>bool</a></span> <span class=o>=</span> <span class=kc>False</span><span class=p>,</span>
90+
<span class=n>autoref_hook</span><span class=p>:</span> <span class=n><span title=mkdocs_autorefs.references.AutorefsHookInterface>AutorefsHookInterface</span></span> <span class=o>|</span> <span class=kc>None</span> <span class=o>=</span> <span class=kc>None</span>
9091
<span class=p>)</span> <span class=o>-&gt;</span> <span class=n><span title=markupsafe.Markup>Markup</span></span>
9192
</code></pre></div> <div class="doc doc-contents "> <p>Render Markdown text; for use inside templates.</p> <p><span class=doc-section-title>Parameters:</span></p> <ul> <li class="doc-section-item field-body"> <h4 id=mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(text) class="doc doc-heading doc-heading-parameter"> <b><code>text</code></b> <a href=#mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(text) class=headerlink title="Permanent link">¤</a></h4> (<code><a class="autorefs autorefs-external" href=https://docs.python.org/3/library/stdtypes.html#str>str</a></code>) – <div class=doc-md-description> <p>The text to convert.</p> </div> </li> <li class="doc-section-item field-body"> <h4 id=mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(heading_level) class="doc doc-heading doc-heading-parameter"> <b><code>heading_level</code></b> <a href=#mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(heading_level) class=headerlink title="Permanent link">¤</a></h4> (<code><a class="autorefs autorefs-external" href=https://docs.python.org/3/library/functions.html#int>int</a></code>) – <div class=doc-md-description> <p>The base heading level to start all Markdown headings from.</p> </div> </li> <li class="doc-section-item field-body"> <h4 id=mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(html_id) class="doc doc-heading doc-heading-parameter"> <b><code>html_id</code></b> <a href=#mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(html_id) class=headerlink title="Permanent link">¤</a></h4> (<code><a class="autorefs autorefs-external" href=https://docs.python.org/3/library/stdtypes.html#str>str</a></code>, default: <code>&#39;&#39;</code> ) – <div class=doc-md-description> <p>The HTML id of the element that's considered the parent of this element.</p> </div> </li> <li class="doc-section-item field-body"> <h4 id=mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(strip_paragraph) class="doc doc-heading doc-heading-parameter"> <b><code>strip_paragraph</code></b> <a href=#mkdocstrings_handlers.python.handler.PythonHandler.do_convert_markdown(strip_paragraph) class=headerlink title="Permanent link">¤</a></h4> (<code><a class="autorefs autorefs-external" href=https://docs.python.org/3/library/functions.html#bool>bool</a></code>, default: <code>False</code> ) – <div class=doc-md-description> <p>Whether to exclude the <p> tag from around the whole output.</p> </div> </li> </ul> <p><span class=doc-section-title>Returns:</span></p> <ul> <li class="doc-section-item field-body"> <code><span title=markupsafe.Markup>Markup</span></code><div class=doc-md-description> <p>An HTML string.</p> </div> </li> </ul> </div> </div> <div class="doc doc-object doc-function"> <h3 id=mkdocstrings_handlers.python.handler.PythonHandler.do_heading class="doc doc-heading"> <code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">do_heading</span> <a href=#mkdocstrings_handlers.python.handler.PythonHandler.do_heading class=headerlink title="Permanent link">¤</a></h3> <div class="language-python doc-signature highlight"><pre><span></span><code><span class=nf>do_heading</span><span class=p>(</span>
9293
<span class=n><a class="autorefs autorefs-internal" href=#mkdocstrings_handlers.python.handler.PythonHandler.do_heading(content)>content</a></span><span class=p>:</span> <span class=n><span title=markupsafe.Markup>Markup</span></span><span class=p>,</span>

reference/mkdocstrings_handlers/python/rendering/index.html

Lines changed: 19 additions & 1 deletion
Large diffs are not rendered by default.

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

sitemap.xml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,102 +2,102 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://mkdocstrings.github.io/python/</loc>
5-
<lastmod>2024-09-01</lastmod>
5+
<lastmod>2024-09-03</lastmod>
66
</url>
77
<url>
88
<loc>https://mkdocstrings.github.io/python/changelog/</loc>
9-
<lastmod>2024-09-01</lastmod>
9+
<lastmod>2024-09-03</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://mkdocstrings.github.io/python/code_of_conduct/</loc>
13-
<lastmod>2024-09-01</lastmod>
13+
<lastmod>2024-09-03</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://mkdocstrings.github.io/python/contributing/</loc>
17-
<lastmod>2024-09-01</lastmod>
17+
<lastmod>2024-09-03</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://mkdocstrings.github.io/python/credits/</loc>
21-
<lastmod>2024-09-01</lastmod>
21+
<lastmod>2024-09-03</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://mkdocstrings.github.io/python/license/</loc>
25-
<lastmod>2024-09-01</lastmod>
25+
<lastmod>2024-09-03</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://mkdocstrings.github.io/python/insiders/</loc>
29-
<lastmod>2024-09-01</lastmod>
29+
<lastmod>2024-09-03</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://mkdocstrings.github.io/python/insiders/changelog/</loc>
33-
<lastmod>2024-09-01</lastmod>
33+
<lastmod>2024-09-03</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://mkdocstrings.github.io/python/insiders/installation/</loc>
37-
<lastmod>2024-09-01</lastmod>
37+
<lastmod>2024-09-03</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://mkdocstrings.github.io/python/reference/SUMMARY/</loc>
41-
<lastmod>2024-09-01</lastmod>
41+
<lastmod>2024-09-03</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/</loc>
45-
<lastmod>2024-09-01</lastmod>
45+
<lastmod>2024-09-03</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/debug/</loc>
49-
<lastmod>2024-09-01</lastmod>
49+
<lastmod>2024-09-03</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/handler/</loc>
53-
<lastmod>2024-09-01</lastmod>
53+
<lastmod>2024-09-03</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/rendering/</loc>
57-
<lastmod>2024-09-01</lastmod>
57+
<lastmod>2024-09-03</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://mkdocstrings.github.io/python/usage/</loc>
61-
<lastmod>2024-09-01</lastmod>
61+
<lastmod>2024-09-03</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://mkdocstrings.github.io/python/usage/customization/</loc>
65-
<lastmod>2024-09-01</lastmod>
65+
<lastmod>2024-09-03</lastmod>
6666
</url>
6767
<url>
6868
<loc>https://mkdocstrings.github.io/python/usage/extensions/</loc>
69-
<lastmod>2024-09-01</lastmod>
69+
<lastmod>2024-09-03</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://mkdocstrings.github.io/python/usage/configuration/docstrings/</loc>
73-
<lastmod>2024-09-01</lastmod>
73+
<lastmod>2024-09-03</lastmod>
7474
</url>
7575
<url>
7676
<loc>https://mkdocstrings.github.io/python/usage/configuration/general/</loc>
77-
<lastmod>2024-09-01</lastmod>
77+
<lastmod>2024-09-03</lastmod>
7878
</url>
7979
<url>
8080
<loc>https://mkdocstrings.github.io/python/usage/configuration/headings/</loc>
81-
<lastmod>2024-09-01</lastmod>
81+
<lastmod>2024-09-03</lastmod>
8282
</url>
8383
<url>
8484
<loc>https://mkdocstrings.github.io/python/usage/configuration/members/</loc>
85-
<lastmod>2024-09-01</lastmod>
85+
<lastmod>2024-09-03</lastmod>
8686
</url>
8787
<url>
8888
<loc>https://mkdocstrings.github.io/python/usage/configuration/signatures/</loc>
89-
<lastmod>2024-09-01</lastmod>
89+
<lastmod>2024-09-03</lastmod>
9090
</url>
9191
<url>
9292
<loc>https://mkdocstrings.github.io/python/usage/docstrings/google/</loc>
93-
<lastmod>2024-09-01</lastmod>
93+
<lastmod>2024-09-03</lastmod>
9494
</url>
9595
<url>
9696
<loc>https://mkdocstrings.github.io/python/usage/docstrings/numpy/</loc>
97-
<lastmod>2024-09-01</lastmod>
97+
<lastmod>2024-09-03</lastmod>
9898
</url>
9999
<url>
100100
<loc>https://mkdocstrings.github.io/python/usage/docstrings/sphinx/</loc>
101-
<lastmod>2024-09-01</lastmod>
101+
<lastmod>2024-09-03</lastmod>
102102
</url>
103103
</urlset>

sitemap.xml.gz

1 Byte
Binary file not shown.

0 commit comments

Comments
 (0)