rebuilt docs

web2py · Jul 16, 2024 · c658a46 · c658a46
1 parent 8af7290
commit c658a46
Show file tree

Hide file tree

Showing 46 changed files with 196 additions and 190 deletions.
diff --git a/apps/_documentation/static/en/.buildinfo b/apps/_documentation/static/en/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d62c19ebef7c157f7809c434c3c4b977
+config: 719409c852540c9b2fc6f3ba7d8ee30d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/apps/_documentation/static/en/_static/documentation_options.js b/apps/_documentation/static/en/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '20240630',
+    VERSION: '20240713',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/apps/_documentation/static/en/chapter-01.html b/apps/_documentation/static/en/chapter-01.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>What is py4web? &mdash; py4web 20240630 documentation</title>
+  <title>What is py4web? &mdash; py4web 20240713 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -18,7 +18,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=5f3eb493"></script>
+        <script src="_static/documentation_options.js?v=d08cd428"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/js/toggle.js?v=e1b5a5a1"></script>
@@ -42,7 +42,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                20240630
+                20240713
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -258,7 +258,7 @@ <h2>Acknowledgments<a class="headerlink" href="#acknowledgments" title="Link to
      <label for="switch"></label>
      </span>
 
-      v: 20240630
+      v: 20240713
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">

diff --git a/apps/_documentation/static/en/chapter-02.html b/apps/_documentation/static/en/chapter-02.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Help, resources and hints &mdash; py4web 20240630 documentation</title>
+  <title>Help, resources and hints &mdash; py4web 20240713 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -18,7 +18,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=5f3eb493"></script>
+        <script src="_static/documentation_options.js?v=d08cd428"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/js/toggle.js?v=e1b5a5a1"></script>
@@ -42,7 +42,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                20240630
+                20240713
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -273,7 +273,7 @@ <h2>How to contribute<a class="headerlink" href="#how-to-contribute" title="Link
      <label for="switch"></label>
      </span>
 
-      v: 20240630
+      v: 20240713
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">

diff --git a/apps/_documentation/static/en/chapter-03.html b/apps/_documentation/static/en/chapter-03.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation and Startup &mdash; py4web 20240630 documentation</title>
+  <title>Installation and Startup &mdash; py4web 20240713 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -18,7 +18,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=5f3eb493"></script>
+        <script src="_static/documentation_options.js?v=d08cd428"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/tabs.js?v=3030b3cb"></script>
@@ -43,7 +43,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                20240630
+                20240713
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -733,7 +733,7 @@ <h3>Deployment on Ubuntu<a class="headerlink" href="#deployment-on-ubuntu" title
      <label for="switch"></label>
      </span>
 
-      v: 20240630
+      v: 20240713
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">

diff --git a/apps/_documentation/static/en/chapter-04.html b/apps/_documentation/static/en/chapter-04.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>The Dashboard &mdash; py4web 20240630 documentation</title>
+  <title>The Dashboard &mdash; py4web 20240713 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -18,7 +18,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=5f3eb493"></script>
+        <script src="_static/documentation_options.js?v=d08cd428"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/js/toggle.js?v=e1b5a5a1"></script>
@@ -42,7 +42,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                20240630
+                20240713
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -200,7 +200,7 @@ <h2>Login into the Dashboard<a class="headerlink" href="#login-into-the-dashboar
      <label for="switch"></label>
      </span>
 
-      v: 20240630
+      v: 20240713
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">

diff --git a/apps/_documentation/static/en/chapter-05.html b/apps/_documentation/static/en/chapter-05.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Creating an app &mdash; py4web 20240630 documentation</title>
+  <title>Creating an app &mdash; py4web 20240713 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -18,7 +18,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=5f3eb493"></script>
+        <script src="_static/documentation_options.js?v=d08cd428"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/js/toggle.js?v=e1b5a5a1"></script>
@@ -42,7 +42,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                20240630
+                20240713
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -502,7 +502,7 @@ <h2>Watch for files change<a class="headerlink" href="#watch-for-files-change" t
      <label for="switch"></label>
      </span>
 
-      v: 20240630
+      v: 20240713
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">

diff --git a/apps/_documentation/static/en/chapter-06.html b/apps/_documentation/static/en/chapter-06.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Fixtures &mdash; py4web 20240630 documentation</title>
+  <title>Fixtures &mdash; py4web 20240713 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -18,7 +18,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=5f3eb493"></script>
+        <script src="_static/documentation_options.js?v=d08cd428"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/js/toggle.js?v=e1b5a5a1"></script>
@@ -42,7 +42,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                20240630
+                20240713
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -297,7 +297,7 @@ <h2>The Translator fixture<a class="headerlink" href="#the-translator-fixture" t
     <span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="n">T</span><span class="o">=</span><span class="n">T</span><span class="p">)</span>
 </pre></div>
 </div>
-<p>Or perahps inject (same effect as above)</p>
+<p>Or perhaps inject (same effect as above)</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">py4web.utils.factories</span> <span class="kn">import</span> <span class="n">Inject</span>
 
 <span class="nd">@action</span><span class="p">(</span><span class="s1">&#39;index&#39;</span><span class="p">)</span>
@@ -344,8 +344,12 @@ <h2>The Translator fixture<a class="headerlink" href="#the-translator-fixture" t
 </div>
 <p>Set your browser preference to Italian: now the messages will be
 automatically translated to Italian.</p>
-<p>Notice there is UI for creating, updating, and updating translation files.
-The UI is accessing via a button from the Dashboard.</p>
+<p>Notice there is an UI in the Dashboard for creating, updating, and updating translation files.
+It can be easily reached via the button <code class="docutils literal notranslate"><span class="pre">i18n+p11n</span></code>:</p>
+<img alt="_images/dashboard_i18n_btn.png" src="_images/dashboard_i18n_btn.png" />
+<p>that leads to the following interface:</p>
+<img alt="_images/dashboard_i18n_ui.png" src="_images/dashboard_i18n_ui.png" />
+<p>More details can be found here: <a class="reference external" href="https://github.com/web2py/pluralize">https://github.com/web2py/pluralize</a></p>
 <p>If you want to force an action to use language defined somewhere else, for example from a session variable, you can do:</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="nd">@action</span><span class="p">(</span><span class="s1">&#39;index&#39;</span><span class="p">)</span>
 <span class="nd">@action</span><span class="o">.</span><span class="n">uses</span><span class="p">(</span><span class="s2">&quot;index.html&quot;</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">T</span><span class="p">)</span>
@@ -359,7 +363,7 @@ <h2>The Translator fixture<a class="headerlink" href="#the-translator-fixture" t
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">T</span><span class="o">.</span><span class="n">on_request</span> <span class="o">=</span> <span class="k">lambda</span> <span class="o">*</span><span class="n">_</span><span class="p">:</span> <span class="n">T</span><span class="o">.</span><span class="n">local</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">tag</span><span class="o">=</span><span class="s2">&quot;it&quot;</span><span class="p">,</span> <span class="n">language</span><span class="o">=</span><span class="n">T</span><span class="o">.</span><span class="n">languages</span><span class="p">[</span><span class="s2">&quot;it&quot;</span><span class="p">])</span>
 </pre></div>
 </div>
-<p>This is to be done outside any action and will apply to all actions. Action will still need todeclare
+<p>This is to be done outside any action and will apply to all actions. Action will still need to declare
 <cite>action.uses(T)</cite> else the behavior is undefined.</p>
 </section>
 <section id="the-flash-fixture">
@@ -1045,7 +1049,7 @@ <h2>Convenience Decorators<a class="headerlink" href="#convenience-decorators" t
      <label for="switch"></label>
      </span>
 
-      v: 20240630
+      v: 20240713
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">

diff --git a/apps/_documentation/static/en/chapter-07.html b/apps/_documentation/static/en/chapter-07.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>The Database Abstraction Layer (DAL) &mdash; py4web 20240630 documentation</title>
+  <title>The Database Abstraction Layer (DAL) &mdash; py4web 20240713 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -18,7 +18,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=5f3eb493"></script>
+        <script src="_static/documentation_options.js?v=d08cd428"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/js/toggle.js?v=e1b5a5a1"></script>
@@ -42,7 +42,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                20240630
+                20240713
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -843,7 +843,7 @@ <h4>Database folder location<a class="headerlink" href="#database-folder-locatio
 <a class="reference internal" href="#migrations">Migrations</a> for details). By default it’s automatically set within py4web on the same
 folder of the database itself, but you have to specify it when using DAL outside py4web.</p>
 <p>Note that for SQLite databases it’s normally necessary,
-otherwise you’ll implictly choose an in memory database (where folder and
+otherwise you’ll implicitly choose an in memory database (where folder and
 migrations don’t have any sense). So these constructors have the same meaning:</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">db</span> <span class="o">=</span> <span class="n">DAL</span><span class="p">(</span><span class="s1">&#39;sqlite://storage.sqlite&#39;</span><span class="p">)</span> <span class="c1"># folder parameter not specified</span>
 <span class="n">db</span> <span class="o">=</span> <span class="n">DAL</span><span class="p">(</span><span class="s1">&#39;sqlite:memory&#39;</span><span class="p">)</span>           <span class="c1"># in memory database</span>
@@ -2652,7 +2652,7 @@ <h3>Caching selects<a class="headerlink" href="#caching-selects" title="Link to
 <p>The select method also takes a <code class="docutils literal notranslate"><span class="pre">cache</span></code> argument, which defaults to
 None. For caching purposes, it should be set to a tuple where the first
 element is the cache function with signature <cite>(key, callback, expiration)</cite>
-(ror example <code class="docutils literal notranslate"><span class="pre">cache.get</span></code> assuming <code class="docutils literal notranslate"><span class="pre">cache</span></code>
+(for example <code class="docutils literal notranslate"><span class="pre">cache.get</span></code> assuming <code class="docutils literal notranslate"><span class="pre">cache</span></code>
 is an instance of the py4web cache object), and
 the second element is the expiration time in seconds.</p>
 <p>In the following example, you see a controller that caches a select on
@@ -4575,7 +4575,7 @@ <h3>Google NoSQL (Datastore)<a class="headerlink" href="#google-nosql-datastore"
      <label for="switch"></label>
      </span>
 
-      v: 20240630
+      v: 20240713
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">

diff --git a/apps/_documentation/static/en/chapter-08.html b/apps/_documentation/static/en/chapter-08.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>The RestAPI &mdash; py4web 20240630 documentation</title>
+  <title>The RestAPI &mdash; py4web 20240713 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -18,7 +18,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=5f3eb493"></script>
+        <script src="_static/documentation_options.js?v=d08cd428"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
         <script src="_static/js/toggle.js?v=e1b5a5a1"></script>
@@ -42,7 +42,7 @@
               <img src="_static/logo.png" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                20240630
+                20240713
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -1171,7 +1171,7 @@ <h2>The RestAPI response<a class="headerlink" href="#the-restapi-response" title
      <label for="switch"></label>
      </span>
 
-      v: 20240630
+      v: 20240713
       <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">