Merge pull request #956 from kvch/gh-pages

update documentation

_sources/dev/install/installation.txt

@@ -99,6 +99,8 @@ this content:
     single-interpreter = true
     master = true
     plugin = python
+    lazy-apps = true
+    enable-threads = true
 
     # Module to import
     module = searx.webapp

_sources/dev/search_api.txt

@@ -31,3 +31,5 @@ Parameters
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
 | ``time_range``   | Time range of search                                                                               | optional (possible: ``day``, ``month``, ``year``)|
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
+| ``format``       | Output format of results                                                                           | optional (possible: ``json``, ``csv``, ``rss``)  |
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+

dev/quickstart.html

@@ -109,20 +109,22 @@ Node has to be installed.</p>
 </div>
 <div class="section" id="tips-for-debugging-development">
 <h2>Tips for debugging/development<a class="headerlink" href="#tips-for-debugging-development" title="Permalink to this headline">¶</a></h2>
-<ol class="arabic simple">
+<ol class="arabic">
 <li><dl class="first docutils">
 <dt>Turn on debug logging</dt>
-<dd>Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
+<dd><p class="first last">Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
 to turn on debug logging. When debug logging is enabled a stack trace appears,
 instead of the cryptic <code class="docutils literal"><span class="pre">Internal</span> <span class="pre">Server</span> <span class="pre">Error</span></code> message. It can be turned on by setting
-<code class="docutils literal"><span class="pre">debug:</span> <span class="pre">False</span></code> to <code class="docutils literal"><span class="pre">debug:</span> <span class="pre">True</span></code> in settings.yml.</dd>
+<code class="docutils literal"><span class="pre">debug:</span> <span class="pre">False</span></code> to <code class="docutils literal"><span class="pre">debug:</span> <span class="pre">True</span></code> in settings.yml.</p>
+</dd>
 </dl>
 </li>
 <li><dl class="first docutils">
 <dt>Run <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> before creating a PR.</dt>
-<dd>Failing build on Travis is common because of PEP8 checks. So a new commit must be created
+<dd><p class="first last">Failing build on Travis is common because of PEP8 checks. So a new commit must be created
 containing these format fixes. This phase can be skipped if <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> is run
-locally before creating a PR.</dd>
+locally before creating a PR.</p>
+</dd>
 </dl>
 </li>
 </ol>

dev/search_api.html

@@ -90,6 +90,10 @@
 <td>Time range of search</td>
 <td>optional (possible: <code class="docutils literal"><span class="pre">day</span></code>, <code class="docutils literal"><span class="pre">month</span></code>, <code class="docutils literal"><span class="pre">year</span></code>)</td>
 </tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">format</span></code></td>
+<td>Output format of results</td>
+<td>optional (possible: <code class="docutils literal"><span class="pre">json</span></code>, <code class="docutils literal"><span class="pre">csv</span></code>, <code class="docutils literal"><span class="pre">rss</span></code>)</td>
+</tr>
 </tbody>
 </table>
 </div>

docs/dev/search_api.rst

@@ -31,3 +31,5 @@ Parameters
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
 | ``time_range``   | Time range of search                                                                               | optional (possible: ``day``, ``month``, ``year``)|
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
+| ``format``       | Output format of results                                                                           | optional (possible: ``json``, ``csv``, ``rss``)  |
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+

requirements.txt

@@ -1 +1 @@
-sphinx==1.4.8
+sphinx==1.6.2