build from commit 31786a2

.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: 70cc4f4c2575408993cffaa1d36fb5bf
+config: ae6e5a4af654b8605f809f476ac019a2
 tags: 645f666f9bcd5a90fca523b33c5a78b7

404.html

@@ -5,11 +5,11 @@
     <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">
-    <title>Page not found &#8212; SearXNG Documentation (2023.9.20+1db335cc)</title>
+    <title>Page not found &#8212; SearXNG Documentation (2023.9.29+31786a2d)</title>
     <link rel="stylesheet" type="text/css" href="/_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="/_static/searxng.css?v=52e4ff28" />
     <link rel="stylesheet" type="text/css" href="/_static/tabs.css?v=a5c4661c" />
-    <script src="/_static/documentation_options.js?v=b5f712e3"></script>
+    <script src="/_static/documentation_options.js?v=6ae5147f"></script>
     <script src="/_static/doctools.js?v=888ff710"></script>
     <script src="/_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="/_static/tabs.js?v=3030b3cb"></script>
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="/py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="/index.html">SearXNG Documentation (2023.9.20+1db335cc)</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="/index.html">SearXNG Documentation (2023.9.29+31786a2d)</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Page not found</a></li> 
       </ul>
     </div>  

_modules/index.html

@@ -5,11 +5,11 @@
     <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">
-    <title>Overview: module code &#8212; SearXNG Documentation (2023.9.20+1db335cc)</title>
+    <title>Overview: module code &#8212; SearXNG Documentation (2023.9.29+31786a2d)</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/searxng.css?v=52e4ff28" />
     <link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=a5c4661c" />
-    <script src="../_static/documentation_options.js?v=b5f712e3"></script>
+    <script src="../_static/documentation_options.js?v=6ae5147f"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/tabs.js?v=3030b3cb"></script>
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2023.9.20+1db335cc)</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">SearXNG Documentation (2023.9.29+31786a2d)</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
       </ul>
     </div>  

_modules/searx/autocomplete.html

@@ -5,11 +5,11 @@
     <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">
-    <title>searx.autocomplete &#8212; SearXNG Documentation (2023.9.20+1db335cc)</title>
+    <title>searx.autocomplete &#8212; SearXNG Documentation (2023.9.29+31786a2d)</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
     <link rel="stylesheet" type="text/css" href="../../_static/tabs.css?v=a5c4661c" />
-    <script src="../../_static/documentation_options.js?v=b5f712e3"></script>
+    <script src="../../_static/documentation_options.js?v=6ae5147f"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/tabs.js?v=3030b3cb"></script>
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2023.9.20+1db335cc)</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2023.9.29+31786a2d)</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">searx.autocomplete</a></li> 
       </ul>

_modules/searx/babel_extract.html

@@ -5,11 +5,11 @@
     <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">
-    <title>searx.babel_extract &#8212; SearXNG Documentation (2023.9.20+1db335cc)</title>
+    <title>searx.babel_extract &#8212; SearXNG Documentation (2023.9.29+31786a2d)</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
     <link rel="stylesheet" type="text/css" href="../../_static/tabs.css?v=a5c4661c" />
-    <script src="../../_static/documentation_options.js?v=b5f712e3"></script>
+    <script src="../../_static/documentation_options.js?v=6ae5147f"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/tabs.js?v=3030b3cb"></script>
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2023.9.20+1db335cc)</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2023.9.29+31786a2d)</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">searx.babel_extract</a></li> 
       </ul>

_modules/searx/botdetection/_helpers.html

@@ -5,11 +5,11 @@
     <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">
-    <title>searx.botdetection._helpers &#8212; SearXNG Documentation (2023.9.20+1db335cc)</title>
+    <title>searx.botdetection._helpers &#8212; SearXNG Documentation (2023.9.29+31786a2d)</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
     <link rel="stylesheet" type="text/css" href="../../../_static/tabs.css?v=a5c4661c" />
-    <script src="../../../_static/documentation_options.js?v=b5f712e3"></script>
+    <script src="../../../_static/documentation_options.js?v=6ae5147f"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/tabs.js?v=3030b3cb"></script>
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2023.9.20+1db335cc)</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2023.9.29+31786a2d)</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">searx.botdetection._helpers</a></li> 
       </ul>
@@ -107,7 +107,7 @@ <h1>Source code for searx.botdetection._helpers</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="get_real_ip">
-<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.get_real_ip">[docs]</a>
+<a class="viewcode-back" href="../../../admin/searx.botdetection.html#searx.botdetection.get_real_ip">[docs]</a>
 <span class="k">def</span> <span class="nf">get_real_ip</span><span class="p">(</span><span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns real IP of the request.  Since not all proxies set all the HTTP</span>
 <span class="sd">    headers and incoming headers can be faked it may happen that the IP cannot</span>

_modules/searx/botdetection/ip_lists.html

@@ -5,11 +5,11 @@
     <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">
-    <title>searx.botdetection.ip_lists &#8212; SearXNG Documentation (2023.9.20+1db335cc)</title>
+    <title>searx.botdetection.ip_lists &#8212; SearXNG Documentation (2023.9.29+31786a2d)</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
     <link rel="stylesheet" type="text/css" href="../../../_static/tabs.css?v=a5c4661c" />
-    <script src="../../../_static/documentation_options.js?v=b5f712e3"></script>
+    <script src="../../../_static/documentation_options.js?v=6ae5147f"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/tabs.js?v=3030b3cb"></script>
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2023.9.20+1db335cc)</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2023.9.29+31786a2d)</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">searx.botdetection.ip_lists</a></li> 
       </ul>
@@ -86,7 +86,7 @@ <h1>Source code for searx.botdetection.ip_lists</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="pass_ip">
-<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.ip_lists.pass_ip">[docs]</a>
+<a class="viewcode-back" href="../../../admin/searx.botdetection.html#searx.botdetection.ip_lists.pass_ip">[docs]</a>
 <span class="k">def</span> <span class="nf">pass_ip</span><span class="p">(</span><span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Checks if the IP on the subnet is in one of the members of the</span>
 <span class="sd">    ``botdetection.ip_lists.pass_ip`` list.</span>
@@ -102,7 +102,7 @@ <h1>Source code for searx.botdetection.ip_lists</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="block_ip">
-<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.ip_lists.block_ip">[docs]</a>
+<a class="viewcode-back" href="../../../admin/searx.botdetection.html#searx.botdetection.ip_lists.block_ip">[docs]</a>
 <span class="k">def</span> <span class="nf">block_ip</span><span class="p">(</span><span class="n">real_ip</span><span class="p">:</span> <span class="n">IPv4Address</span> <span class="o">|</span> <span class="n">IPv6Address</span><span class="p">,</span> <span class="n">cfg</span><span class="p">:</span> <span class="n">config</span><span class="o">.</span><span class="n">Config</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">str</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Checks if the IP on the subnet is in one of the members of the</span>
 <span class="sd">    ``botdetection.ip_lists.block_ip`` list.</span>

_modules/searx/botdetection/link_token.html

@@ -5,11 +5,11 @@
     <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">
-    <title>searx.botdetection.link_token &#8212; SearXNG Documentation (2023.9.20+1db335cc)</title>
+    <title>searx.botdetection.link_token &#8212; SearXNG Documentation (2023.9.29+31786a2d)</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
     <link rel="stylesheet" type="text/css" href="../../../_static/tabs.css?v=a5c4661c" />
-    <script src="../../../_static/documentation_options.js?v=b5f712e3"></script>
+    <script src="../../../_static/documentation_options.js?v=6ae5147f"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/tabs.js?v=3030b3cb"></script>
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2023.9.20+1db335cc)</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2023.9.29+31786a2d)</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">searx.botdetection.link_token</a></li> 
       </ul>
@@ -110,7 +110,7 @@ <h1>Source code for searx.botdetection.link_token</h1><div class="highlight"><pr
 
 
 <div class="viewcode-block" id="is_suspicious">
-<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.is_suspicious">[docs]</a>
+<a class="viewcode-back" href="../../../admin/searx.botdetection.html#searx.botdetection.link_token.is_suspicious">[docs]</a>
 <span class="k">def</span> <span class="nf">is_suspicious</span><span class="p">(</span><span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">,</span> <span class="n">renew</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Checks whether a valid ping is exists for this (client) network, if not</span>
 <span class="sd">    this request is rated as *suspicious*.  If a valid ping exists and argument</span>
@@ -136,7 +136,7 @@ <h1>Source code for searx.botdetection.link_token</h1><div class="highlight"><pr
 
 
 <div class="viewcode-block" id="ping">
-<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.ping">[docs]</a>
+<a class="viewcode-back" href="../../../admin/searx.botdetection.html#searx.botdetection.link_token.ping">[docs]</a>
 <span class="k">def</span> <span class="nf">ping</span><span class="p">(</span><span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">,</span> <span class="n">token</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;This function is called by a request to URL ``/client&lt;token&gt;.css``.  If</span>
 <span class="sd">    ``token`` is valid a :py:obj:`PING_KEY` for the client is stored in the DB.</span>
@@ -162,7 +162,7 @@ <h1>Source code for searx.botdetection.link_token</h1><div class="highlight"><pr
 
 
 <div class="viewcode-block" id="get_ping_key">
-<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.get_ping_key">[docs]</a>
+<a class="viewcode-back" href="../../../admin/searx.botdetection.html#searx.botdetection.link_token.get_ping_key">[docs]</a>
 <span class="k">def</span> <span class="nf">get_ping_key</span><span class="p">(</span><span class="n">network</span><span class="p">:</span> <span class="n">IPv4Network</span> <span class="o">|</span> <span class="n">IPv6Network</span><span class="p">,</span> <span class="n">request</span><span class="p">:</span> <span class="n">flask</span><span class="o">.</span><span class="n">Request</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Generates a hashed key that fits (more or less) to a *WEB-browser</span>
 <span class="sd">    session* in a network.&quot;&quot;&quot;</span>
@@ -184,7 +184,7 @@ <h1>Source code for searx.botdetection.link_token</h1><div class="highlight"><pr
 
 
 <div class="viewcode-block" id="get_token">
-<a class="viewcode-back" href="../../../src/searx.botdetection.html#searx.botdetection.link_token.get_token">[docs]</a>
+<a class="viewcode-back" href="../../../admin/searx.botdetection.html#searx.botdetection.link_token.get_token">[docs]</a>
 <span class="k">def</span> <span class="nf">get_token</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns current token.  If there is no currently active token a new token</span>
 <span class="sd">    is generated randomly and stored in the redis DB.</span>