docs update

This commit is contained in:
Dirk Alders 2025-08-17 11:18:30 +02:00
parent ef8d79b187
commit e2e839fe6f
9 changed files with 33 additions and 72 deletions

View File

@ -1,4 +0,0 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: b08cae1d15d0beb3312bc445500082d9
tags: 645f666f9bcd5a90fca523b33c5a78b7

View File

@ -0,0 +1,7 @@
fstools package
===============
.. automodule:: fstools
:members:
:show-inheritance:
:undoc-members:

View File

@ -1,24 +0,0 @@
.. documentation master file, created by
sphinx-quickstart on Fri Jan 1 19:56:01 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to cachings's documentation!
====================================
.. automodule:: fstools
:members:
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -5,7 +5,7 @@
<meta charset="utf-8" /> <meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Welcome to cachingss documentation! &#8212; fstools documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>fstools package &#8212; fstools documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=67a6116b" /> <link rel="stylesheet" type="text/css" href="_static/classic.css?v=67a6116b" />
@ -61,7 +61,7 @@
<div> <div>
<h3><a href="#">Table of Contents</a></h3> <h3><a href="#">Table of Contents</a></h3>
<ul> <ul>
<li><a class="reference internal" href="#">Welcome to cachingss documentation!</a><ul> <li><a class="reference internal" href="#">fstools package</a><ul>
<li><a class="reference internal" href="#fstools-filesystem-tools">fstools (Filesystem Tools)</a></li> <li><a class="reference internal" href="#fstools-filesystem-tools">fstools (Filesystem Tools)</a></li>
<li><a class="reference internal" href="#fstools.dirlist"><code class="docutils literal notranslate"><span class="pre">dirlist()</span></code></a></li> <li><a class="reference internal" href="#fstools.dirlist"><code class="docutils literal notranslate"><span class="pre">dirlist()</span></code></a></li>
<li><a class="reference internal" href="#fstools.filelist"><code class="docutils literal notranslate"><span class="pre">filelist()</span></code></a></li> <li><a class="reference internal" href="#fstools.filelist"><code class="docutils literal notranslate"><span class="pre">filelist()</span></code></a></li>
@ -73,14 +73,13 @@
<li><a class="reference internal" href="#fstools.uid_filelist"><code class="docutils literal notranslate"><span class="pre">uid_filelist()</span></code></a></li> <li><a class="reference internal" href="#fstools.uid_filelist"><code class="docutils literal notranslate"><span class="pre">uid_filelist()</span></code></a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul> </ul>
</div> </div>
<div role="note" aria-label="source link"> <div role="note" aria-label="source link">
<h3>This Page</h3> <h3>This Page</h3>
<ul class="this-page-menu"> <ul class="this-page-menu">
<li><a href="_sources/index.rst.txt" <li><a href="_sources/fstools.rst.txt"
rel="nofollow">Show Source</a></li> rel="nofollow">Show Source</a></li>
</ul> </ul>
</div> </div>
@ -115,10 +114,10 @@
</li> </li>
<li> <li>
<a href="#">fstools documentation</a> &#187; <a href="index.html">fstools documentation</a> &#187;
</li> </li>
<li class="nav-item nav-item-this"><a href="">Welcome to cachingss documentation!</a></li> <li class="nav-item nav-item-this"><a href="">fstools package</a></li>
<li class="right"> <li class="right">
@ -149,7 +148,7 @@
<div class="body" role="main"> <div class="body" role="main">
<section id="module-fstools"> <section id="module-fstools">
<span id="welcome-to-cachings-s-documentation"></span><h1>Welcome to cachingss documentation!<a class="headerlink" href="#module-fstools" title="Link to this heading"></a></h1> <span id="fstools-package"></span><h1>fstools package<a class="headerlink" href="#module-fstools" title="Link to this heading"></a></h1>
<section id="fstools-filesystem-tools"> <section id="fstools-filesystem-tools">
<h2>fstools (Filesystem Tools)<a class="headerlink" href="#fstools-filesystem-tools" title="Link to this heading"></a></h2> <h2>fstools (Filesystem Tools)<a class="headerlink" href="#fstools-filesystem-tools" title="Link to this heading"></a></h2>
<p><strong>Author:</strong></p> <p><strong>Author:</strong></p>
@ -172,7 +171,7 @@
</ul> </ul>
<p><strong>Unittest:</strong></p> <p><strong>Unittest:</strong></p>
<blockquote> <blockquote>
<div><p>See also the <a class="reference download internal" download="" href="_downloads/c68c8cb37d326ff4fa7a0781182bc493/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</p> <div><p>See also the <a class="reference download internal" download="" href="_downloads/b85965799001dc2e1f803d0d8e7a7320/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</p>
</div></blockquote> </div></blockquote>
<p><strong>Module Documentation:</strong></p> <p><strong>Module Documentation:</strong></p>
</section> </section>
@ -218,14 +217,8 @@
<span class="o">../</span><span class="n">_docs_</span> <span class="o">../</span><span class="n">_docs_</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_sources</span> <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_sources</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span> <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">css</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">css</span><span class="o">/</span><span class="n">fonts</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">js</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">fonts</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">fonts</span><span class="o">/</span><span class="n">RobotoSlab</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_static</span><span class="o">/</span><span class="n">fonts</span><span class="o">/</span><span class="n">Lato</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_downloads</span> <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_downloads</span>
<span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_downloads</span><span class="o">/</span><span class="mi">7</span><span class="n">bf10188aa659556c284b4a8298dba8d</span> <span class="o">../</span><span class="n">_docs_</span><span class="o">/</span><span class="n">_downloads</span><span class="o">/</span><span class="n">c68c8cb37d326ff4fa7a0781182bc493</span>
<span class="o">../</span><span class="n">_testresults_</span> <span class="o">../</span><span class="n">_testresults_</span>
</pre></div> </pre></div>
</div> </div>
@ -438,7 +431,7 @@ max_staleness tries to avoid the worst for these cases.</p>
<span class="nb">print</span><span class="p">(</span><span class="n">fstools</span><span class="o">.</span><span class="n">uid</span><span class="p">(</span><span class="s1">&#39;../__init__.py&#39;</span><span class="p">))</span> <span class="nb">print</span><span class="p">(</span><span class="n">fstools</span><span class="o">.</span><span class="n">uid</span><span class="p">(</span><span class="s1">&#39;../__init__.py&#39;</span><span class="p">))</span>
</pre></div> </pre></div>
</div> </div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">2</span><span class="n">de37f8d3569d049e82932f8293c402d59e8bda8</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">2</span><span class="n">ec81b9ec51963c1dc140c51b903e7149df0c92e</span>
</pre></div> </pre></div>
</div> </div>
<p>Using just the files mtime to determine if the file has changed is <p>Using just the files mtime to determine if the file has changed is
@ -489,21 +482,11 @@ reliable then <a class="reference internal" href="#fstools.uid" title="fstools.u
<span class="nb">print</span><span class="p">(</span><span class="n">fstools</span><span class="o">.</span><span class="n">uid_filelist</span><span class="p">(</span><span class="s1">&#39;..&#39;</span><span class="p">,</span> <span class="s1">&#39;*.py&#39;</span><span class="p">,</span> <span class="n">rekursive</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span> <span class="nb">print</span><span class="p">(</span><span class="n">fstools</span><span class="o">.</span><span class="n">uid_filelist</span><span class="p">(</span><span class="s1">&#39;..&#39;</span><span class="p">,</span> <span class="s1">&#39;*.py&#39;</span><span class="p">,</span> <span class="n">rekursive</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
</pre></div> </pre></div>
</div> </div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">92</span><span class="n">a26594015be798c2a5b438595067e9</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">54</span><span class="n">da6f4b94010fba1501b316e7e91e50</span>
</pre></div> </pre></div>
</div> </div>
</dd></dl> </dd></dl>
<div class="toctree-wrapper compound">
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section> </section>
@ -516,7 +499,7 @@ reliable then <a class="reference internal" href="#fstools.uid" title="fstools.u
<div> <div>
<h3><a href="#">Table of Contents</a></h3> <h3><a href="#">Table of Contents</a></h3>
<ul> <ul>
<li><a class="reference internal" href="#">Welcome to cachingss documentation!</a><ul> <li><a class="reference internal" href="#">fstools package</a><ul>
<li><a class="reference internal" href="#fstools-filesystem-tools">fstools (Filesystem Tools)</a></li> <li><a class="reference internal" href="#fstools-filesystem-tools">fstools (Filesystem Tools)</a></li>
<li><a class="reference internal" href="#fstools.dirlist"><code class="docutils literal notranslate"><span class="pre">dirlist()</span></code></a></li> <li><a class="reference internal" href="#fstools.dirlist"><code class="docutils literal notranslate"><span class="pre">dirlist()</span></code></a></li>
<li><a class="reference internal" href="#fstools.filelist"><code class="docutils literal notranslate"><span class="pre">filelist()</span></code></a></li> <li><a class="reference internal" href="#fstools.filelist"><code class="docutils literal notranslate"><span class="pre">filelist()</span></code></a></li>
@ -528,14 +511,13 @@ reliable then <a class="reference internal" href="#fstools.uid" title="fstools.u
<li><a class="reference internal" href="#fstools.uid_filelist"><code class="docutils literal notranslate"><span class="pre">uid_filelist()</span></code></a></li> <li><a class="reference internal" href="#fstools.uid_filelist"><code class="docutils literal notranslate"><span class="pre">uid_filelist()</span></code></a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul> </ul>
</div> </div>
<div role="note" aria-label="source link"> <div role="note" aria-label="source link">
<h3>This Page</h3> <h3>This Page</h3>
<ul class="this-page-menu"> <ul class="this-page-menu">
<li><a href="_sources/index.rst.txt" <li><a href="_sources/fstools.rst.txt"
rel="nofollow">Show Source</a></li> rel="nofollow">Show Source</a></li>
</ul> </ul>
</div> </div>
@ -570,10 +552,10 @@ reliable then <a class="reference internal" href="#fstools.uid" title="fstools.u
</li> </li>
<li> <li>
<a href="#">fstools documentation</a> &#187; <a href="index.html">fstools documentation</a> &#187;
</li> </li>
<li class="nav-item nav-item-this"><a href="">Welcome to cachingss documentation!</a></li> <li class="nav-item nav-item-this"><a href="">fstools package</a></li>
<li class="right"> <li class="right">

View File

@ -136,7 +136,7 @@
<h2 id="D">D</h2> <h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#fstools.dirlist">dirlist() (in module fstools)</a> <li><a href="fstools.html#fstools.dirlist">dirlist() (in module fstools)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -144,7 +144,7 @@
<h2 id="F">F</h2> <h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#fstools.filelist">filelist() (in module fstools)</a> <li><a href="fstools.html#fstools.filelist">filelist() (in module fstools)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
@ -152,7 +152,7 @@
fstools fstools
<ul> <ul>
<li><a href="index.html#module-fstools">module</a> <li><a href="fstools.html#module-fstools">module</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -161,7 +161,7 @@
<h2 id="I">I</h2> <h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#fstools.is_writeable">is_writeable() (in module fstools)</a> <li><a href="fstools.html#fstools.is_writeable">is_writeable() (in module fstools)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -169,7 +169,7 @@
<h2 id="M">M</h2> <h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#fstools.mkdir">mkdir() (in module fstools)</a> <li><a href="fstools.html#fstools.mkdir">mkdir() (in module fstools)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
@ -177,7 +177,7 @@
module module
<ul> <ul>
<li><a href="index.html#module-fstools">fstools</a> <li><a href="fstools.html#module-fstools">fstools</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -186,11 +186,11 @@
<h2 id="O">O</h2> <h2 id="O">O</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#fstools.open_locked_blocking">open_locked_blocking() (in module fstools)</a> <li><a href="fstools.html#fstools.open_locked_blocking">open_locked_blocking() (in module fstools)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#fstools.open_locked_non_blocking">open_locked_non_blocking() (in module fstools)</a> <li><a href="fstools.html#fstools.open_locked_non_blocking">open_locked_non_blocking() (in module fstools)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -198,11 +198,11 @@
<h2 id="U">U</h2> <h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#fstools.uid">uid() (in module fstools)</a> <li><a href="fstools.html#fstools.uid">uid() (in module fstools)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#fstools.uid_filelist">uid_filelist() (in module fstools)</a> <li><a href="fstools.html#fstools.uid_filelist">uid_filelist() (in module fstools)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>

Binary file not shown.

View File

@ -142,7 +142,7 @@
<tr> <tr>
<td></td> <td></td>
<td> <td>
<a href="index.html#module-fstools"><code class="xref">fstools</code></a></td><td> <a href="fstools.html#module-fstools"><code class="xref">fstools</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
</table> </table>

File diff suppressed because one or more lines are too long