Skip to content

Commit

Permalink
Generate docs: 8731626
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Aug 9, 2023
1 parent 7e17882 commit f3aa6ea
Show file tree
Hide file tree
Showing 5 changed files with 224 additions and 11 deletions.
217 changes: 215 additions & 2 deletions extras.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,54 @@
__setitem__()
</a>

</li>

<li class="md-nav__item">
<a href="#mkdocs_gen_files.nav.Nav.items" class="md-nav__link">
items()
</a>

</li>

<li class="md-nav__item">
<a href="#mkdocs_gen_files.nav.Nav.build_literate_nav" class="md-nav__link">
build_literate_nav()
</a>

</li>

<li class="md-nav__item">
<a href="#mkdocs_gen_files.nav.Nav.Item" class="md-nav__link">
Item
</a>

<nav class="md-nav" aria-label="Item">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#mkdocs_gen_files.nav.Nav.Item.level" class="md-nav__link">
level
</a>

</li>

<li class="md-nav__item">
<a href="#mkdocs_gen_files.nav.Nav.Item.title" class="md-nav__link">
title
</a>

</li>

<li class="md-nav__item">
<a href="#mkdocs_gen_files.nav.Nav.Item.filename" class="md-nav__link">
filename
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -607,8 +655,6 @@ <h3 id="reference-mkdocs_gen_filesnav">Reference: <code>mkdocs_gen_files.Nav</co





<div class="doc doc-object doc-function">


Expand Down Expand Up @@ -636,6 +682,173 @@ <h4 id="mkdocs_gen_files.nav.Nav.__setitem__" class="doc doc-heading">






<div class="doc doc-object doc-function">



<h4 id="mkdocs_gen_files.nav.Nav.items" class="doc doc-heading">
<code class="highlight language-python"><span class="n">items</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Item</span><span class="p">]</span></code>

<a href="#mkdocs_gen_files.nav.Nav.items" class="headerlink" title="Permanent link">#</a></h4>


<div class="doc doc-contents ">

<p>Allows viewing the nav as a flattened sequence.</p>

</div>

</div>






<div class="doc doc-object doc-function">



<h4 id="mkdocs_gen_files.nav.Nav.build_literate_nav" class="doc doc-heading">
<code class="highlight language-python"><span class="n">build_literate_nav</span><span class="p">(</span><span class="n">indentation</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Iterable</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span></code>

<a href="#mkdocs_gen_files.nav.Nav.build_literate_nav" class="headerlink" title="Permanent link">#</a></h4>


<div class="doc doc-contents ">

<p>Builds a file suitable for <a href="https://github.com/oprypin/mkdocs-literate-nav">https://github.com/oprypin/mkdocs-literate-nav</a>, as a sequence of lines to be written into a file.</p>
<p>For an example, see <a href="https://mkdocstrings.github.io/recipes/#generate-a-literate-navigation-file">https://mkdocstrings.github.io/recipes/#generate-a-literate-navigation-file</a></p>

</div>

</div>






<div class="doc doc-object doc-class">



<h4 id="mkdocs_gen_files.nav.Nav.Item" class="doc doc-heading">
<code>Item</code>


<span class="doc doc-labels">
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
</span>

<a href="#mkdocs_gen_files.nav.Nav.Item" class="headerlink" title="Permanent link">#</a></h4>


<div class="doc doc-contents ">


<p>An item in the navigation.</p>





<div class="doc doc-children">







<div class="doc doc-object doc-attribute">



<h5 id="mkdocs_gen_files.nav.Nav.Item.level" class="doc doc-heading">
<code class="highlight language-python"><span class="n">level</span><span class="p">:</span> <span class="nb">int</span></code>

<span class="doc doc-labels">
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
</span>

<a href="#mkdocs_gen_files.nav.Nav.Item.level" class="headerlink" title="Permanent link">#</a></h5>


<div class="doc doc-contents ">

<p>The nestedness level of the item. 0 is the topmost level.</p>
</div>

</div>






<div class="doc doc-object doc-attribute">



<h5 id="mkdocs_gen_files.nav.Nav.Item.title" class="doc doc-heading">
<code class="highlight language-python"><span class="n">title</span><span class="p">:</span> <span class="nb">str</span></code>

<span class="doc doc-labels">
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
</span>

<a href="#mkdocs_gen_files.nav.Nav.Item.title" class="headerlink" title="Permanent link">#</a></h5>


<div class="doc doc-contents ">

<p>The title of the item.</p>
</div>

</div>






<div class="doc doc-object doc-attribute">



<h5 id="mkdocs_gen_files.nav.Nav.Item.filename" class="doc doc-heading">
<code class="highlight language-python"><span class="n">filename</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span></code>

<span class="doc doc-labels">
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
</span>

<a href="#mkdocs_gen_files.nav.Nav.Item.filename" class="headerlink" title="Permanent link">#</a></h5>


<div class="doc doc-contents ">

<p>The path the item links to (or it can be a section index without a link).</p>
</div>

</div>




</div>

</div>

</div>




</div>

</div>
Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,42 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://oprypin.github.io/mkdocs-gen-files/index.html</loc>
<lastmod>2023-08-01</lastmod>
<lastmod>2023-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://oprypin.github.io/mkdocs-gen-files/api.html</loc>
<lastmod>2023-08-01</lastmod>
<lastmod>2023-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://oprypin.github.io/mkdocs-gen-files/extras.html</loc>
<lastmod>2023-08-01</lastmod>
<lastmod>2023-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://oprypin.github.io/mkdocs-gen-files/sample/19-bottles.html</loc>
<lastmod>2023-08-01</lastmod>
<lastmod>2023-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://oprypin.github.io/mkdocs-gen-files/sample/39-bottles.html</loc>
<lastmod>2023-08-01</lastmod>
<lastmod>2023-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://oprypin.github.io/mkdocs-gen-files/sample/59-bottles.html</loc>
<lastmod>2023-08-01</lastmod>
<lastmod>2023-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://oprypin.github.io/mkdocs-gen-files/sample/79-bottles.html</loc>
<lastmod>2023-08-01</lastmod>
<lastmod>2023-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://oprypin.github.io/mkdocs-gen-files/sample/99-bottles.html</loc>
<lastmod>2023-08-01</lastmod>
<lastmod>2023-08-09</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit f3aa6ea

Please sign in to comment.