Skip to content

Commit

Permalink
Deployed 157224d with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
@pawamoy
pawamoy committed Jan 31, 2024
1 parent 422a55b commit c3c03ba
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

50 changes: 25 additions & 25 deletions sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,127 +2,127 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://mkdocstrings.github.io/python/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/changelog/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/code_of_conduct/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/contributing/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/credits/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/license/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/insiders/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/insiders/changelog/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/insiders/installation/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/reference/SUMMARY/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/debug/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/handler/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/reference/mkdocstrings_handlers/python/rendering/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/customization/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/extensions/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/configuration/docstrings/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/configuration/general/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/configuration/headings/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/configuration/members/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/configuration/signatures/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/docstrings/google/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/docstrings/numpy/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://mkdocstrings.github.io/python/usage/docstrings/sphinx/</loc>
<lastmod>2024-01-30</lastmod>
<lastmod>2024-01-31</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion usage/customization/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@
<span class=x> </span><span class=cp>{{</span> <span class=nb>block</span><span class=nv>.super</span> <span class=cp>}}</span>
<span class=x> Additional contents</span>
<span class=cp>{%</span> <span class=k>endblock</span> <span class=nv>contents</span> <span class=cp>%}</span>
</code></pre></div> <h3 id=available-blocks>Available blocks<a class=headerlink href=#available-blocks title="Permanent link">¤</a></h3> <p>Only the templates for the <strong>Material for MkDocs</strong> provide Jinja blocks. The following tables show the block names, description, and the Jinja context available in their scope.</p> <h4 id=modulehtml><code>module.html</code><a class=headerlink href=#modulehtml title="Permanent link">¤</a></h4> <ul> <li><code>heading</code>: The module heading.</li> <li><code>labels</code>: The module labels.</li> <li><code>contents</code>: The module contents: docstring and children blocks.</li> <li><code>docstring</code>: The module docstring.</li> <li><code>summary</code>: The automatic summaries of members.</li> <li><code>children</code>: The module children.</li> </ul> <p>Available context:</p> <ul> <li><code>config</code>: The handler configuration (dictionary).</li> <li><code>module</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Module>Module</a> instance.</li> </ul> <h4 id=classhtml><code>class.html</code><a class=headerlink href=#classhtml title="Permanent link">¤</a></h4> <ul> <li><code>heading</code>: The class heading.</li> <li><code>labels</code>: The class labels.</li> <li><code>signature</code>: The class signature.</li> <li><code>contents</code>: The class contents: bases, docstring, source and children blocks.</li> <li><code>bases</code>: The class bases.</li> <li><code>docstring</code>: The class docstring.</li> <li><code>summary</code>: The automatic summaries of members.</li> <li><code>source</code>: The class source code.</li> <li><code>children</code>: The class children.</li> </ul> <p>Available context:</p> <ul> <li><code>config</code>: The handler configuration (dictionary).</li> <li><code>class</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Class>Class</a> instance.</li> </ul> <h4 id=functionhtml><code>function.html</code><a class=headerlink href=#functionhtml title="Permanent link">¤</a></h4> <ul> <li><code>heading</code>: The function heading.</li> <li><code>labels</code>: The function labels.</li> <li><code>signature</code>: The function signature.</li> <li><code>contents</code>: The function contents: docstring and source blocks.</li> <li><code>docstring</code>: The function docstring.</li> <li><code>source</code>: The function source code.</li> </ul> <p>Available context:</p> <ul> <li><code>config</code>: The handler configuration (dictionary).</li> <li><code>function</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Function>Function</a> instance.</li> </ul> <h4 id=attributehtml><code>attribute.html</code><a class=headerlink href=#attributehtml title="Permanent link">¤</a></h4> <ul> <li><code>heading</code>: The attribute heading.</li> <li><code>labels</code>: The attribute labels.</li> <li><code>signature</code>: The attribute signature.</li> <li><code>contents</code>: The attribute contents: docstring block.</li> <li><code>docstring</code>: The attribute docstring.</li> </ul> <p>Available context:</p> <ul> <li><code>config</code>: The handler configuration (dictionary).</li> <li><code>function</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Attribute>Attribute</a> instance.</li> </ul> <h4 id=docstring-sections>Docstring sections<a class=headerlink href=#docstring-sections title="Permanent link">¤</a></h4> <p>In <code>docstring/attributes.html</code>, <code>docstring/functions.html</code>, <code>docstring/classes.html</code>, <code>docstring/modules.html</code>, <code>docstring/other_parameters.html</code>, <code>docstring/parameters.html</code>, <code>docstring/raises.html</code>, <code>docstring/receives.html</code>, <code>docstring/returns.html</code>, <code>docstring/warns.html</code>, and <code>docstring/yields.html</code>:</p> <ul> <li><code>table_style</code>: The section as a table.</li> <li><code>list_style</code>: The section as a list.</li> <li><code>spacy_style</code>: The section as a Spacy table.</li> </ul> <p>Available context:</p> <ul> <li><code>section</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/docstrings/dataclasses/#griffe.docstrings.dataclasses.DocstringSection>DocstringSection</a> instance (see <code>DocstringSection*</code> subclasses).</li> </ul> <h2 id=style-recommendations>Style recommendations<a class=headerlink href=#style-recommendations title="Permanent link">¤</a></h2> <p><a id=recommended-style-material></a></p> <h3 id=material>Material<a class=headerlink href=#material title="Permanent link">¤</a></h3> <p>Here are some CSS rules for the <a href=https://squidfunk.github.io/mkdocs-material>Material for MkDocs</a> theme:</p> <div class=highlight><pre><span></span><code><span class=c>/* Indentation. */</span>
</code></pre></div> <h3 id=available-blocks>Available blocks<a class=headerlink href=#available-blocks title="Permanent link">¤</a></h3> <p>Only the templates for the <strong>Material for MkDocs</strong> provide Jinja blocks. The following tables show the block names, description, and the Jinja context available in their scope.</p> <h4 id=modulehtml><code>module.html</code><a class=headerlink href=#modulehtml title="Permanent link">¤</a></h4> <ul> <li><code>heading</code>: The module heading.</li> <li><code>labels</code>: The module labels.</li> <li><code>contents</code>: The module contents: docstring and children blocks.</li> <li><code>docstring</code>: The module docstring.</li> <li><code>summary</code>: The automatic summaries of members.</li> <li><code>children</code>: The module children.</li> </ul> <p>Available context:</p> <ul> <li><code>config</code>: The handler configuration (dictionary).</li> <li><code>module</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Module>Module</a> instance.</li> </ul> <h4 id=classhtml><code>class.html</code><a class=headerlink href=#classhtml title="Permanent link">¤</a></h4> <ul> <li><code>heading</code>: The class heading.</li> <li><code>labels</code>: The class labels.</li> <li><code>signature</code>: The class signature.</li> <li><code>contents</code>: The class contents: bases, docstring, source and children blocks.</li> <li><code>bases</code>: The class bases.</li> <li><code>docstring</code>: The class docstring.</li> <li><code>summary</code>: The automatic summaries of members.</li> <li><code>source</code>: The class source code.</li> <li><code>children</code>: The class children.</li> </ul> <p>Available context:</p> <ul> <li><code>config</code>: The handler configuration (dictionary).</li> <li><code>class</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Class>Class</a> instance.</li> </ul> <h4 id=functionhtml><code>function.html</code><a class=headerlink href=#functionhtml title="Permanent link">¤</a></h4> <ul> <li><code>heading</code>: The function heading.</li> <li><code>labels</code>: The function labels.</li> <li><code>signature</code>: The function signature.</li> <li><code>contents</code>: The function contents: docstring and source blocks.</li> <li><code>docstring</code>: The function docstring.</li> <li><code>source</code>: The function source code.</li> </ul> <p>Available context:</p> <ul> <li><code>config</code>: The handler configuration (dictionary).</li> <li><code>function</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Function>Function</a> instance.</li> </ul> <h4 id=attributehtml><code>attribute.html</code><a class=headerlink href=#attributehtml title="Permanent link">¤</a></h4> <ul> <li><code>heading</code>: The attribute heading.</li> <li><code>labels</code>: The attribute labels.</li> <li><code>signature</code>: The attribute signature.</li> <li><code>contents</code>: The attribute contents: docstring block.</li> <li><code>docstring</code>: The attribute docstring.</li> </ul> <p>Available context:</p> <ul> <li><code>config</code>: The handler configuration (dictionary).</li> <li><code>attribute</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Attribute>Attribute</a> instance.</li> </ul> <h4 id=docstring-sections>Docstring sections<a class=headerlink href=#docstring-sections title="Permanent link">¤</a></h4> <p>In <code>docstring/attributes.html</code>, <code>docstring/functions.html</code>, <code>docstring/classes.html</code>, <code>docstring/modules.html</code>, <code>docstring/other_parameters.html</code>, <code>docstring/parameters.html</code>, <code>docstring/raises.html</code>, <code>docstring/receives.html</code>, <code>docstring/returns.html</code>, <code>docstring/warns.html</code>, and <code>docstring/yields.html</code>:</p> <ul> <li><code>table_style</code>: The section as a table.</li> <li><code>list_style</code>: The section as a list.</li> <li><code>spacy_style</code>: The section as a Spacy table.</li> </ul> <p>Available context:</p> <ul> <li><code>section</code>: The <a class="autorefs autorefs-external" href=https://mkdocstrings.github.io/griffe/reference/griffe/docstrings/dataclasses/#griffe.docstrings.dataclasses.DocstringSection>DocstringSection</a> instance (see <code>DocstringSection*</code> subclasses).</li> </ul> <h2 id=style-recommendations>Style recommendations<a class=headerlink href=#style-recommendations title="Permanent link">¤</a></h2> <p><a id=recommended-style-material></a></p> <h3 id=material>Material<a class=headerlink href=#material title="Permanent link">¤</a></h3> <p>Here are some CSS rules for the <a href=https://squidfunk.github.io/mkdocs-material>Material for MkDocs</a> theme:</p> <div class=highlight><pre><span></span><code><span class=c>/* Indentation. */</span>
<span class=nt>div</span><span class=p>.</span><span class=nc>doc-contents</span><span class=p>:</span><span class=nd>not</span><span class=o>(</span><span class=p>.</span><span class=nc>first</span><span class=o>)</span><span class=w> </span><span class=p>{</span>
<span class=w> </span><span class=k>padding-left</span><span class=p>:</span><span class=w> </span><span class=mi>25</span><span class=kt>px</span><span class=p>;</span>
<span class=w> </span><span class=k>border-left</span><span class=p>:</span><span class=w> </span><span class=mf>.05</span><span class=kt>rem</span><span class=w> </span><span class=kc>solid</span><span class=w> </span><span class=nf>var</span><span class=p>(</span><span class=nv>--md-typeset-table-color</span><span class=p>);</span>
Expand Down

0 comments on commit c3c03ba

Please sign in to comment.