Update documentation

api/watch/index.html

@@ -714,6 +714,12 @@ <h6 id="watchfiles.watch--force-polling">Force polling<a class="headerlink" href
 </li>
 <li>otherwise, we enable force polling only if we detect we're running on WSL (Windows Subsystem for Linux)</li>
 </ul>
+<p>It is also possible to change the poll delay between iterations, it can be changed to maintain a good response time
+and an appropiate CPU consumption using the <code>poll_delay_ms</code> argument, we change poll delay thus:</p>
+<ul>
+<li>if file polling is enabled and the <code>WATCHFILES_POLL_DELAY_MS</code> env var exists and it is numeric, we use that</li>
+<li>otherwise, we use the argument value</li>
+</ul>
 
 
 
@@ -1143,7 +1149,8 @@ <h2 id="watchfiles.awatch" class="doc doc-heading">
           </td>
           <td>
             <div class="doc-md-description">
-              <p>delay between polling for changes, only used if <code>force_polling=True</code>.</p>
+              <p>delay between polling for changes, only used if <code>force_polling=True</code>.
+<code>poll_delay_ms</code> can be changed via the <code>WATCHFILES_POLL_DELAY_MS</code> environment variable.</p>
             </div>
           </td>
           <td>

index.html

@@ -642,7 +642,7 @@ <h1 id="watchfiles">watchfiles<a class="headerlink" href="#watchfiles" title="Pe
 <a href="https://codecov.io/gh/samuelcolvin/watchfiles"><img alt="Coverage" src="https://codecov.io/gh/samuelcolvin/watchfiles/branch/main/graph/badge.svg" /></a>
 <a href="https://pypi.python.org/pypi/watchfiles"><img alt="pypi" src="https://img.shields.io/pypi/v/watchfiles.svg" /></a>
 <a href="https://github.com/samuelcolvin/watchfiles/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/github/license/samuelcolvin/watchfiles.svg" /></a></p>
-<p>Documentation for version: <strong>v0.24.0</strong>.</p>
+<p>Documentation for version: <strong>v1.0.0</strong>.</p>
 <p>Simple, modern and high performance file watching and code reload in python.</p>
 <p>Underlying file system notifications are handled by the <a href="https://github.com/notify-rs/notify">Notify</a> rust library.</p>
 <p>This package was previously named "watchgod", see <a href="migrating/">Migrating from watchgod</a> for more information.</p>

sitemap.xml

@@ -2,37 +2,37 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://watchfiles.helpmanual.io/</loc>
-         <lastmod>2024-08-28</lastmod>
+         <lastmod>2024-11-25</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://watchfiles.helpmanual.io/cli/</loc>
-         <lastmod>2024-08-28</lastmod>
+         <lastmod>2024-11-25</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://watchfiles.helpmanual.io/migrating/</loc>
-         <lastmod>2024-08-28</lastmod>
+         <lastmod>2024-11-25</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://watchfiles.helpmanual.io/api/filters/</loc>
-         <lastmod>2024-08-28</lastmod>
+         <lastmod>2024-11-25</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://watchfiles.helpmanual.io/api/run_process/</loc>
-         <lastmod>2024-08-28</lastmod>
+         <lastmod>2024-11-25</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://watchfiles.helpmanual.io/api/rust_backend/</loc>
-         <lastmod>2024-08-28</lastmod>
+         <lastmod>2024-11-25</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://watchfiles.helpmanual.io/api/watch/</loc>
-         <lastmod>2024-08-28</lastmod>
+         <lastmod>2024-11-25</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>