Merge pull request #614 from kvch/gh-pages

documentation updates

_sources/admin/api.txt

@@ -0,0 +1,78 @@
+.. _adminapi:
+
+Administration API
+------------------
+
+Get configuration data
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: sh
+
+    GET /config
+
+Sample response
+```````````````
+
+.. code:: sh
+    
+    {
+      "autocomplete": "", 
+      "categories": [
+        "map", 
+        "it", 
+        "images", 
+      ], 
+      "default_locale": "", 
+      "default_theme": "oscar", 
+      "engines": [
+        {
+          "categories": [
+            "map"
+          ], 
+          "enabled": true, 
+          "name": "openstreetmap", 
+          "shortcut": "osm"
+        }, 
+        {
+          "categories": [
+            "it"
+          ], 
+          "enabled": true, 
+          "name": "arch linux wiki", 
+          "shortcut": "al"
+        }, 
+        {
+          "categories": [
+            "images"
+          ], 
+          "enabled": true, 
+          "name": "google images", 
+          "shortcut": "goi"
+        }, 
+        {
+          "categories": [
+            "it"
+          ], 
+          "enabled": false, 
+          "name": "bitbucket", 
+          "shortcut": "bb"
+        }, 
+      ], 
+      "instance_name": "searx", 
+      "locales": {
+        "de": "Deutsch (German)", 
+        "en": "English", 
+        "eo": "Esperanto (Esperanto)", 
+      }, 
+      "plugins": [
+        {
+          "enabled": true, 
+          "name": "HTTPS rewrite"
+        }, 
+        {
+          "enabled": false, 
+          "name": "Vim-like hotkeys"
+        }
+      ], 
+      "safe_search": 0
+    }

_sources/dev/plugins.txt

@@ -1,11 +1,11 @@
 Plugins
 -------
 
-Plugins can extend/replace functionality of various components inside
+Plugins can extend or replace functionality of various components of
 searx.
 
-example\_plugin.py
-~~~~~~~~~~~~~~~~~~
+Example plugin
+~~~~~~~~~~~~~~
 
 .. code:: python
 
@@ -24,22 +24,22 @@ example\_plugin.py
         ctx['search'].suggestions.add('example')
         return True
 
-Currently implemented plugin entry points (a.k.a hooks)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Plugin entry points
+~~~~~~~~~~~~~~~~~~~
 
--  Pre search hook (``pre_search``)
--  Post search hook (``post_search``)
--  Result hook (``on_result``) (is called if a new result is added (see
-   https\_rewrite plugin))
+Entry points (hooks) define when a plugin runs. Right now only three hooks are implemented. So feel free to implement a hook if it fits the behaviour of your plugin.
 
-Feel free to add more hooks to the code if it is required by a plugin.
+Pre search hook
+```````````````
 
-TODO
-~~~~
+Runs BEFORE the search request. Function to implement: ``pre_search``
 
--  Better documentation
--  More hooks
--  search hook (is called while searx is requesting results (for
-   example: things like math-solver), the different hooks are running
-   parallel)
+Post search hook
+````````````````
 
+Runs AFTER the search request. Function to implement: ``post_search``
+
+Result hook
+```````````
+
+Runs when a new result is added to the result list. Function to implement: ``on_result``

_sources/dev/search_api.txt

@@ -1,13 +1,20 @@
 Search API
 ==========
 
-Search API endpoints: ``/``, ``/search``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The search supports both ``GET`` and ``POST``. However, using ``GET`` the parameters of the request remain hidden. So it is advised to use ``GET`` for querying.
 
-Endpoints have equivalent functionality.
+Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
+
+.. code:: sh
+
+    GET /
+
+.. code:: sh
+
+    GET /search
 
 Parameters
-^^^^^^^^^^
+``````````
 
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
 | Name             | Description                                                                                        |                             |
@@ -18,7 +25,7 @@ Parameters
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
 | ``engines``      | Comma separated list, specifies the active search engines                                          | optional                    |
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
+| ``lang``         | Code of the language                                                                               | optional (default: ``all``) |
++------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
 | ``pageno``       | Search page number                                                                                 | optional (default: ``1``)   |
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
-
-Both ``GET`` and ``POST`` methods are supported.

_sources/index.txt

@@ -1,7 +1,7 @@
-Privacy-respecting free metasearch engine
-=========================================
+Welcome to searx
+================
 
-Searx is a free software internet metasearch engine which aggregates results from other search engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
+Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
 
 
 Features
@@ -15,16 +15,26 @@ Features
  - Does not collect its users data
  - Offers secure, encrypted connections (HTTPS/SSL)
  - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
+ - About 70 supported search engines
+ - Easy intergration with any search engine
 
 
-Further reading
----------------
+User documentation
+------------------
 
 .. toctree::
    :maxdepth: 1
 
    user/search_syntax
 
+Administrator documentation
+---------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   dev/install/installation
+   admin/api
 
 Developer documentation
 -----------------------
@@ -34,7 +44,6 @@ Developer documentation
 
    dev/quickstart
    dev/contribution_guide
-   dev/install/installation
    dev/engine_overview
    dev/search_api
    dev/plugins

_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -52,6 +52,8 @@ div.sphinxsidebar {
     width: 230px;
     margin-left: -100%;
     font-size: 90%;
+    word-wrap: break-word;
+    overflow-wrap : break-word;
 }
 
 div.sphinxsidebar ul {
@@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
     width: 170px;
 }
 
-div.sphinxsidebar #searchbox input[type="submit"] {
-    width: 30px;
-}
-
 img {
     border: 0;
     max-width: 100%;
@@ -187,6 +185,13 @@ div.genindex-jumpbox {
 
 /* -- general body styles --------------------------------------------------- */
 
+div.body p, div.body dd, div.body li, div.body blockquote {
+    -moz-hyphens: auto;
+    -ms-hyphens: auto;
+    -webkit-hyphens: auto;
+    hyphens: auto;
+}
+
 a.headerlink {
     visibility: hidden;
 }

_static/doctools.js

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -124,6 +124,7 @@ var Documentation = {
     this.fixFirefoxAnchorBug();
     this.highlightSearchWords();
     this.initIndexTable();
+    
   },
 
   /**
@@ -252,6 +253,29 @@ var Documentation = {
     });
     var url = parts.join('/');
     return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
+  },
+
+  initOnKeyListeners: function() {
+    $(document).keyup(function(event) {
+      var activeElementType = document.activeElement.tagName;
+      // don't navigate when in search box or textarea
+      if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
+        switch (event.keyCode) {
+          case 37: // left
+            var prevHref = $('link[rel="prev"]').prop('href');
+            if (prevHref) {
+              window.location.href = prevHref;
+              return false;
+            }
+          case 39: // right
+            var nextHref = $('link[rel="next"]').prop('href');
+            if (nextHref) {
+              window.location.href = nextHref;
+              return false;
+            }
+        }
+      }
+    });
   }
 };
 
@@ -260,4 +284,4 @@ _ = Documentation.gettext;
 
 $(document).ready(function() {
   Documentation.init();
-});
+});

_static/pygments.css

@@ -4,10 +4,8 @@
 .highlight .err { border: 1px solid #FF0000 } /* Error */
 .highlight .k { color: #007020; font-weight: bold } /* Keyword */
 .highlight .o { color: #666666 } /* Operator */
-.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
 .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
 .highlight .cp { color: #007020 } /* Comment.Preproc */
-.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
 .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
 .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */

_static/searchtools.js

@@ -2,9 +2,9 @@
  * searchtools.js_t
  * ~~~~~~~~~~~~~~~~
  *
- * Sphinx JavaScript utilties for the full-text search.
+ * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -623,7 +623,7 @@ var Search = {
    * helper function to return a node containing the
    * search summary for a given text. keywords is a list
    * of stemmed words, hlwords is the list of normal, unstemmed
-   * words. the first one is used to find the occurance, the
+   * words. the first one is used to find the occurrence, the
    * latter for highlighting it.
    */
   makeSearchSummary : function(text, keywords, hlwords) {

_static/style.css

@@ -38,6 +38,8 @@ div.bodywrapper {
 
 div.sphinxsidebar {
     width: 220px;
+    word-wrap: normal !important;
+    overflow-wrap: normal !important;
 }
 
 hr {

_static/websupport.js

@@ -2,9 +2,9 @@
  * websupport.js
  * ~~~~~~~~~~~~~
  *
- * sphinx.websupport utilties for all documentation.
+ * sphinx.websupport utilities for all documentation.
  *
- * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

admin/api.html

@@ -0,0 +1,146 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Administration API &mdash; searx 0.9.0 documentation</title>
+    
+    <link rel="stylesheet" href="../_static/style.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '0.9.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
+    <link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />
+    <link rel="prev" title="Installation" href="../dev/install/installation.html" />
+   
+  
+  <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+
+  </head>
+  <body role="document">  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="administration-api">
+<span id="adminapi"></span><h1>Administration API<a class="headerlink" href="#administration-api" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="get-configuration-data">
+<h2>Get configuration data<a class="headerlink" href="#get-configuration-data" title="Permalink to this headline">¶</a></h2>
+<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">config</span>
+</pre></div>
+</div>
+<div class="section" id="sample-response">
+<h3>Sample response<a class="headerlink" href="#sample-response" title="Permalink to this headline">¶</a></h3>
+<div class="code sh highlight-default"><div class="highlight"><pre><span class="p">{</span>
+  <span class="s">&quot;autocomplete&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
+  <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
+    <span class="s">&quot;map&quot;</span><span class="p">,</span>
+    <span class="s">&quot;it&quot;</span><span class="p">,</span>
+    <span class="s">&quot;images&quot;</span><span class="p">,</span>
+  <span class="p">],</span>
+  <span class="s">&quot;default_locale&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
+  <span class="s">&quot;default_theme&quot;</span><span class="p">:</span> <span class="s">&quot;oscar&quot;</span><span class="p">,</span>
+  <span class="s">&quot;engines&quot;</span><span class="p">:</span> <span class="p">[</span>
+    <span class="p">{</span>
+      <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
+        <span class="s">&quot;map&quot;</span>
+      <span class="p">],</span>
+      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;openstreetmap&quot;</span><span class="p">,</span>
+      <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;osm&quot;</span>
+    <span class="p">},</span>
+    <span class="p">{</span>
+      <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
+        <span class="s">&quot;it&quot;</span>
+      <span class="p">],</span>
+      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;arch linux wiki&quot;</span><span class="p">,</span>
+      <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;al&quot;</span>
+    <span class="p">},</span>
+    <span class="p">{</span>
+      <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
+        <span class="s">&quot;images&quot;</span>
+      <span class="p">],</span>
+      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;google images&quot;</span><span class="p">,</span>
+      <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;goi&quot;</span>
+    <span class="p">},</span>
+    <span class="p">{</span>
+      <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
+        <span class="s">&quot;it&quot;</span>
+      <span class="p">],</span>
+      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;bitbucket&quot;</span><span class="p">,</span>
+      <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;bb&quot;</span>
+    <span class="p">},</span>
+  <span class="p">],</span>
+  <span class="s">&quot;instance_name&quot;</span><span class="p">:</span> <span class="s">&quot;searx&quot;</span><span class="p">,</span>
+  <span class="s">&quot;locales&quot;</span><span class="p">:</span> <span class="p">{</span>
+    <span class="s">&quot;de&quot;</span><span class="p">:</span> <span class="s">&quot;Deutsch (German)&quot;</span><span class="p">,</span>
+    <span class="s">&quot;en&quot;</span><span class="p">:</span> <span class="s">&quot;English&quot;</span><span class="p">,</span>
+    <span class="s">&quot;eo&quot;</span><span class="p">:</span> <span class="s">&quot;Esperanto (Esperanto)&quot;</span><span class="p">,</span>
+  <span class="p">},</span>
+  <span class="s">&quot;plugins&quot;</span><span class="p">:</span> <span class="p">[</span>
+    <span class="p">{</span>
+      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;HTTPS rewrite&quot;</span>
+    <span class="p">},</span>
+    <span class="p">{</span>
+      <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+      <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Vim-like hotkeys&quot;</span>
+    <span class="p">}</span>
+  <span class="p">],</span>
+  <span class="s">&quot;safe_search&quot;</span><span class="p">:</span> <span class="mi">0</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
+<h1>Searx</h1>
+<ul>
+    <li><a href="../index.html">Home</a></li>
+    <li><a href="https://github.com/asciimoo/searx">Source</a></li>
+    <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
+    <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
+</ul>
+<hr />
+<ul>
+    <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
+    <li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
+    <li><a href="https://gratipay.com/searx">Gratipay</a></li>
+</ul>
+</div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy; Copyright 2015-2016, Adam Tauber.
+    </div>
+  </body>
+</html>

dev/contribution_guide.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>How to contribute &mdash; searx 0.8.0 documentation</title>
+    <title>How to contribute &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,8 +23,8 @@
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
-    <link rel="next" title="Installation" href="install/installation.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
+    <link rel="next" title="Engine overview" href="engine_overview.html" />
     <link rel="prev" title="Development Quickstart" href="quickstart.html" />
    
   
@@ -146,7 +146,7 @@ files, you have to install it on your system. (It can be installed easily using
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

dev/engine_overview.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Engine overview &mdash; searx 0.8.0 documentation</title>
+    <title>Engine overview &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,9 +23,9 @@
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
     <link rel="next" title="Search API" href="search_api.html" />
-    <link rel="prev" title="Installation" href="install/installation.html" />
+    <link rel="prev" title="How to contribute" href="contribution_guide.html" />
    
   
   <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@@ -190,10 +190,10 @@ overrides are the following:</p>
 </div>
 <div class="section" id="example-code">
 <h3><a class="toc-backref" href="#id7">example code</a><a class="headerlink" href="#example-code" title="Permalink to this headline">¶</a></h3>
-<div class="code python highlight-python"><div class="highlight"><pre><span class="c1"># engine dependent config</span>
-<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span>
-<span class="n">paging</span> <span class="o">=</span> <span class="bp">True</span>
-<span class="n">language_support</span> <span class="o">=</span> <span class="bp">True</span>
+<div class="code python highlight-default"><div class="highlight"><pre><span class="c"># engine dependent config</span>
+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;general&#39;</span><span class="p">]</span>
+<span class="n">paging</span> <span class="o">=</span> <span class="k">True</span>
+<span class="n">language_support</span> <span class="o">=</span> <span class="k">True</span>
 </pre></div>
 </div>
 </div>
@@ -313,17 +313,17 @@ used to specify a search request:</p>
 </div>
 <div class="section" id="id1">
 <h3><a class="toc-backref" href="#id11">example code</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
-<div class="code python highlight-python"><div class="highlight"><pre><span class="c1"># search-url</span>
-<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://example.com/&#39;</span>
-<span class="n">search_string</span> <span class="o">=</span> <span class="s1">&#39;search?{query}&amp;page={page}&#39;</span>
+<div class="code python highlight-default"><div class="highlight"><pre><span class="c"># search-url</span>
+<span class="n">base_url</span> <span class="o">=</span> <span class="s">&#39;https://example.com/&#39;</span>
+<span class="n">search_string</span> <span class="o">=</span> <span class="s">&#39;search?{query}&amp;page={page}&#39;</span>
 
-<span class="c1"># do search-request</span>
+<span class="c"># do search-request</span>
 <span class="k">def</span> <span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
     <span class="n">search_path</span> <span class="o">=</span> <span class="n">search_string</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
-        <span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span>
-        <span class="n">page</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">])</span>
+        <span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span>
+        <span class="n">page</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;pageno&#39;</span><span class="p">])</span>
 
-    <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">search_path</span>
+    <span class="n">params</span><span class="p">[</span><span class="s">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">search_path</span>
 
     <span class="k">return</span> <span class="n">params</span>
 </pre></div>
@@ -582,7 +582,7 @@ Currently the following media-types are supported:</p>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

dev/install/installation.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Installation &mdash; searx 0.8.0 documentation</title>
+    <title>Installation &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="../../_static/style.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,9 +23,9 @@
     <script type="text/javascript" src="../../_static/jquery.js"></script>
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="../../index.html" />
-    <link rel="next" title="Engine overview" href="../engine_overview.html" />
-    <link rel="prev" title="How to contribute" href="../contribution_guide.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="../../index.html" />
+    <link rel="next" title="Administration API" href="../../admin/api.html" />
+    <link rel="prev" title="Search syntax" href="../../user/search_syntax.html" />
    
   
   <link media="only screen and (max-device-width: 480px)" href="../../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@@ -332,7 +332,7 @@ docker run -d --name searx -p $PORT:8888 wonderfall/searx
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

dev/plugins.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Plugins &mdash; searx 0.8.0 documentation</title>
+    <title>Plugins &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,7 +23,7 @@
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
     <link rel="next" title="Translation" href="translation.html" />
     <link rel="prev" title="Search API" href="search_api.html" />
    
@@ -41,46 +41,42 @@
             
   <div class="section" id="plugins">
 <h1>Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline">¶</a></h1>
-<p>Plugins can extend/replace functionality of various components inside
+<p>Plugins can extend or replace functionality of various components of
 searx.</p>
-<div class="section" id="example-plugin-py">
-<h2>example_plugin.py<a class="headerlink" href="#example-plugin-py" title="Permalink to this headline">¶</a></h2>
-<div class="code python highlight-python"><div class="highlight"><pre><span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;Example plugin&#39;</span>
-<span class="n">description</span> <span class="o">=</span> <span class="s1">&#39;This plugin extends the suggestions with the word &quot;example&quot;&#39;</span>
-<span class="n">default_on</span> <span class="o">=</span> <span class="bp">False</span>  <span class="c1"># disable by default</span>
+<div class="section" id="example-plugin">
+<h2>Example plugin<a class="headerlink" href="#example-plugin" title="Permalink to this headline">¶</a></h2>
+<div class="code python highlight-default"><div class="highlight"><pre><span class="n">name</span> <span class="o">=</span> <span class="s">&#39;Example plugin&#39;</span>
+<span class="n">description</span> <span class="o">=</span> <span class="s">&#39;This plugin extends the suggestions with the word &quot;example&quot;&#39;</span>
+<span class="n">default_on</span> <span class="o">=</span> <span class="k">False</span>  <span class="c"># disable by default</span>
 
-<span class="n">js_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span>  <span class="c1"># optional, list of static js files</span>
-<span class="n">css_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span>  <span class="c1"># optional, list of static css files</span>
+<span class="n">js_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span>  <span class="c"># optional, list of static js files</span>
+<span class="n">css_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span>  <span class="c"># optional, list of static css files</span>
 
 
-<span class="c1"># attach callback to the post search hook</span>
-<span class="c1">#  request: flask request object</span>
-<span class="c1">#  ctx: the whole local context of the post search hook</span>
+<span class="c"># attach callback to the post search hook</span>
+<span class="c">#  request: flask request object</span>
+<span class="c">#  ctx: the whole local context of the post search hook</span>
 <span class="k">def</span> <span class="nf">post_search</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
-    <span class="n">ctx</span><span class="p">[</span><span class="s1">&#39;search&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">suggestions</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">&#39;example&#39;</span><span class="p">)</span>
-    <span class="k">return</span> <span class="bp">True</span>
+    <span class="n">ctx</span><span class="p">[</span><span class="s">&#39;search&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">suggestions</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s">&#39;example&#39;</span><span class="p">)</span>
+    <span class="k">return</span> <span class="k">True</span>
 </pre></div>
 </div>
 </div>
-<div class="section" id="currently-implemented-plugin-entry-points-a-k-a-hooks">
-<h2>Currently implemented plugin entry points (a.k.a hooks)<a class="headerlink" href="#currently-implemented-plugin-entry-points-a-k-a-hooks" title="Permalink to this headline">¶</a></h2>
-<ul class="simple">
-<li>Pre search hook (<code class="docutils literal"><span class="pre">pre_search</span></code>)</li>
-<li>Post search hook (<code class="docutils literal"><span class="pre">post_search</span></code>)</li>
-<li>Result hook (<code class="docutils literal"><span class="pre">on_result</span></code>) (is called if a new result is added (see
-https_rewrite plugin))</li>
-</ul>
-<p>Feel free to add more hooks to the code if it is required by a plugin.</p>
+<div class="section" id="plugin-entry-points">
+<h2>Plugin entry points<a class="headerlink" href="#plugin-entry-points" title="Permalink to this headline">¶</a></h2>
+<p>Entry points (hooks) define when a plugin runs. Right now only three hooks are implemented. So feel free to implement a hook if it fits the behaviour of your plugin.</p>
+<div class="section" id="pre-search-hook">
+<h3>Pre search hook<a class="headerlink" href="#pre-search-hook" title="Permalink to this headline">¶</a></h3>
+<p>Runs BEFORE the search request. Function to implement: <code class="docutils literal"><span class="pre">pre_search</span></code></p>
+</div>
+<div class="section" id="post-search-hook">
+<h3>Post search hook<a class="headerlink" href="#post-search-hook" title="Permalink to this headline">¶</a></h3>
+<p>Runs AFTER the search request. Function to implement: <code class="docutils literal"><span class="pre">post_search</span></code></p>
+</div>
+<div class="section" id="result-hook">
+<h3>Result hook<a class="headerlink" href="#result-hook" title="Permalink to this headline">¶</a></h3>
+<p>Runs when a new result is added to the result list. Function to implement: <code class="docutils literal"><span class="pre">on_result</span></code></p>
 </div>
-<div class="section" id="todo">
-<h2>TODO<a class="headerlink" href="#todo" title="Permalink to this headline">¶</a></h2>
-<ul class="simple">
-<li>Better documentation</li>
-<li>More hooks</li>
-<li>search hook (is called while searx is requesting results (for
-example: things like math-solver), the different hooks are running
-parallel)</li>
-</ul>
 </div>
 </div>
 
@@ -109,7 +105,7 @@ parallel)</li>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

dev/quickstart.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Development Quickstart &mdash; searx 0.8.0 documentation</title>
+    <title>Development Quickstart &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,9 +23,9 @@
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
     <link rel="next" title="How to contribute" href="contribution_guide.html" />
-    <link rel="prev" title="Search syntax" href="../user/search_syntax.html" />
+    <link rel="prev" title="Administration API" href="../admin/api.html" />
    
   
   <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@@ -154,7 +154,7 @@ locally before creating a PR.</p>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

dev/search_api.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Search API &mdash; searx 0.8.0 documentation</title>
+    <title>Search API &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,7 +23,7 @@
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
     <link rel="next" title="Plugins" href="plugins.html" />
     <link rel="prev" title="Engine overview" href="engine_overview.html" />
    
@@ -41,9 +41,13 @@
             
   <div class="section" id="search-api">
 <h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="search-api-endpoints-search">
-<h2>Search API endpoints: <code class="docutils literal"><span class="pre">/</span></code>, <code class="docutils literal"><span class="pre">/search</span></code><a class="headerlink" href="#search-api-endpoints-search" title="Permalink to this headline">¶</a></h2>
-<p>Endpoints have equivalent functionality.</p>
+<p>The search supports both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code>. However, using <code class="docutils literal"><span class="pre">GET</span></code> the parameters of the request remain hidden. So it is advised to use <code class="docutils literal"><span class="pre">GET</span></code> for querying.</p>
+<p>Furthermore, two enpoints <code class="docutils literal"><span class="pre">/</span></code> and <code class="docutils literal"><span class="pre">/search</span></code> are available for querying.</p>
+<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span>
+</pre></div>
+</div>
+<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">search</span>
+</pre></div>
 </div>
 <div class="section" id="parameters">
 <h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
@@ -61,7 +65,7 @@
 </thead>
 <tbody valign="top">
 <tr class="row-even"><td><code class="docutils literal"><span class="pre">q</span></code></td>
-<td>The search query, see <a class="reference internal" href="../user/search_syntax.html"><em>Search syntax</em></a></td>
+<td>The search query, see <a class="reference internal" href="../user/search_syntax.html"><span class="doc">Search syntax</span></a></td>
 <td>required</td>
 </tr>
 <tr class="row-odd"><td><code class="docutils literal"><span class="pre">categories</span></code></td>
@@ -72,13 +76,16 @@
 <td>Comma separated list, specifies the active search engines</td>
 <td>optional</td>
 </tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pageno</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lang</span></code></td>
+<td>Code of the language</td>
+<td>optional (default: <code class="docutils literal"><span class="pre">all</span></code>)</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">pageno</span></code></td>
 <td>Search page number</td>
 <td>optional (default: <code class="docutils literal"><span class="pre">1</span></code>)</td>
 </tr>
 </tbody>
 </table>
-<p>Both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code> methods are supported.</p>
 </div>
 </div>
 
@@ -107,7 +114,7 @@
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

dev/translation.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Translation &mdash; searx 0.8.0 documentation</title>
+    <title>Translation &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,7 +23,7 @@
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
     <link rel="prev" title="Plugins" href="plugins.html" />
    
   
@@ -43,13 +43,13 @@
 <p>run these commands in the root directory of searx</p>
 <div class="section" id="add-new-language">
 <h2>Add new language<a class="headerlink" href="#add-new-language" title="Permalink to this headline">¶</a></h2>
-<div class="code shell highlight-python"><div class="highlight"><pre>pybabel init -i messages.pot -d searx/translations -l it
+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">pybabel</span> <span class="n">init</span> <span class="o">-</span><span class="n">i</span> <span class="n">messages</span><span class="o">.</span><span class="n">pot</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span> <span class="o">-</span><span class="n">l</span> <span class="n">it</span>
 </pre></div>
 </div>
 </div>
 <div class="section" id="update-po-files">
 <h2>Update .po files<a class="headerlink" href="#update-po-files" title="Permalink to this headline">¶</a></h2>
-<div class="code shell highlight-python"><div class="highlight"><pre>./utils/update-translations.sh
+<div class="code shell highlight-default"><div class="highlight"><pre><span class="o">./</span><span class="n">utils</span><span class="o">/</span><span class="n">update</span><span class="o">-</span><span class="n">translations</span><span class="o">.</span><span class="n">sh</span>
 </pre></div>
 </div>
 <p>You may have errors here. In that case, edit the
@@ -59,7 +59,7 @@
 </div>
 <div class="section" id="compile-translations">
 <h2>Compile translations<a class="headerlink" href="#compile-translations" title="Permalink to this headline">¶</a></h2>
-<div class="code shell highlight-python"><div class="highlight"><pre>pybabel compile -d searx/translations
+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">pybabel</span> <span class="nb">compile</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span>
 </pre></div>
 </div>
 </div>
@@ -67,10 +67,10 @@
 <h2>Transifex stuff<a class="headerlink" href="#transifex-stuff" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="init-project">
 <h3>Init Project<a class="headerlink" href="#init-project" title="Permalink to this headline">¶</a></h3>
-<div class="code shell highlight-python"><div class="highlight"><pre>tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">init</span> <span class="c"># Transifex instance: https://www.transifex.com/asciimoo/searx/</span>
 
-tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39; \
---source-lang en --type PO --source-file messages.pot --execute
+<span class="n">tx</span> <span class="nb">set</span> <span class="o">--</span><span class="n">auto</span><span class="o">-</span><span class="n">local</span> <span class="o">-</span><span class="n">r</span> <span class="n">searx</span><span class="o">.</span><span class="n">messagespo</span> <span class="s">&#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39;</span> \
+<span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="n">lang</span> <span class="n">en</span> <span class="o">--</span><span class="nb">type</span> <span class="n">PO</span> <span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="n">file</span> <span class="n">messages</span><span class="o">.</span><span class="n">pot</span> <span class="o">--</span><span class="n">execute</span>
 </pre></div>
 </div>
 <p><a class="reference external" href="http://docs.transifex.com/client/init/">http://docs.transifex.com/client/init/</a></p>
@@ -78,27 +78,27 @@ tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_
 </div>
 <div class="section" id="get-translations">
 <h3>Get translations<a class="headerlink" href="#get-translations" title="Permalink to this headline">¶</a></h3>
-<div class="code shell highlight-python"><div class="highlight"><pre>tx pull -a
+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">pull</span> <span class="o">-</span><span class="n">a</span>
 </pre></div>
 </div>
 <p><a class="reference external" href="http://docs.transifex.com/client/pull">http://docs.transifex.com/client/pull</a></p>
 </div>
 <div class="section" id="upload-source-file">
 <h3>Upload source File<a class="headerlink" href="#upload-source-file" title="Permalink to this headline">¶</a></h3>
-<div class="code shell highlight-python"><div class="highlight"><pre>tx push -s
+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">s</span>
 </pre></div>
 </div>
 </div>
 <div class="section" id="upload-all-translation">
 <h3>Upload all Translation<a class="headerlink" href="#upload-all-translation" title="Permalink to this headline">¶</a></h3>
-<div class="code shell highlight-python"><div class="highlight"><pre>tx push -s -t
+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">s</span> <span class="o">-</span><span class="n">t</span>
 </pre></div>
 </div>
 </div>
 </div>
 <div class="section" id="upload-specifc-translation">
 <h2>upload specifc Translation<a class="headerlink" href="#upload-specifc-translation" title="Permalink to this headline">¶</a></h2>
-<div class="code shell highlight-python"><div class="highlight"><pre>tx push -t -l tr
+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">t</span> <span class="o">-</span><span class="n">l</span> <span class="n">tr</span>
 </pre></div>
 </div>
 <p><a class="reference external" href="http://docs.transifex.com/client/push">http://docs.transifex.com/client/push</a></p>
@@ -130,7 +130,7 @@ tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

docs/_themes/searx_theme/static/style.css_t

@@ -38,6 +38,8 @@ div.bodywrapper {
 
 div.sphinxsidebar {
     width: {{ sidebar_width }};
+    word-wrap: normal !important;
+    overflow-wrap: normal !important;
 }
 
 hr {

docs/admin/api.rst

@@ -0,0 +1,78 @@
+.. _adminapi:
+
+Administration API
+------------------
+
+Get configuration data
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: sh
+
+    GET /config
+
+Sample response
+```````````````
+
+.. code:: sh
+    
+    {
+      "autocomplete": "", 
+      "categories": [
+        "map", 
+        "it", 
+        "images", 
+      ], 
+      "default_locale": "", 
+      "default_theme": "oscar", 
+      "engines": [
+        {
+          "categories": [
+            "map"
+          ], 
+          "enabled": true, 
+          "name": "openstreetmap", 
+          "shortcut": "osm"
+        }, 
+        {
+          "categories": [
+            "it"
+          ], 
+          "enabled": true, 
+          "name": "arch linux wiki", 
+          "shortcut": "al"
+        }, 
+        {
+          "categories": [
+            "images"
+          ], 
+          "enabled": true, 
+          "name": "google images", 
+          "shortcut": "goi"
+        }, 
+        {
+          "categories": [
+            "it"
+          ], 
+          "enabled": false, 
+          "name": "bitbucket", 
+          "shortcut": "bb"
+        }, 
+      ], 
+      "instance_name": "searx", 
+      "locales": {
+        "de": "Deutsch (German)", 
+        "en": "English", 
+        "eo": "Esperanto (Esperanto)", 
+      }, 
+      "plugins": [
+        {
+          "enabled": true, 
+          "name": "HTTPS rewrite"
+        }, 
+        {
+          "enabled": false, 
+          "name": "Vim-like hotkeys"
+        }
+      ], 
+      "safe_search": 0
+    }

docs/conf.py

@@ -49,7 +49,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'searx'
-copyright = u'2015, Adam Tauber'
+copyright = u'2015-2016, Adam Tauber'
 author = u'Adam Tauber'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -57,9 +57,9 @@ author = u'Adam Tauber'
 # built documents.
 #
 # The short X.Y version.
-version = '0.8.0'
+version = '0.9.0'
 # The full version, including alpha/beta/rc tags.
-release = '0.8.0'
+release = '0.9.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/dev/plugins.rst

@@ -1,11 +1,11 @@
 Plugins
 -------
 
-Plugins can extend/replace functionality of various components inside
+Plugins can extend or replace functionality of various components of
 searx.
 
-example\_plugin.py
-~~~~~~~~~~~~~~~~~~
+Example plugin
+~~~~~~~~~~~~~~
 
 .. code:: python
 
@@ -24,22 +24,22 @@ example\_plugin.py
         ctx['search'].suggestions.add('example')
         return True
 
-Currently implemented plugin entry points (a.k.a hooks)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Plugin entry points
+~~~~~~~~~~~~~~~~~~~
 
--  Pre search hook (``pre_search``)
--  Post search hook (``post_search``)
--  Result hook (``on_result``) (is called if a new result is added (see
-   https\_rewrite plugin))
+Entry points (hooks) define when a plugin runs. Right now only three hooks are implemented. So feel free to implement a hook if it fits the behaviour of your plugin.
 
-Feel free to add more hooks to the code if it is required by a plugin.
+Pre search hook
+```````````````
 
-TODO
-~~~~
+Runs BEFORE the search request. Function to implement: ``pre_search``
 
--  Better documentation
--  More hooks
--  search hook (is called while searx is requesting results (for
-   example: things like math-solver), the different hooks are running
-   parallel)
+Post search hook
+````````````````
 
+Runs AFTER the search request. Function to implement: ``post_search``
+
+Result hook
+```````````
+
+Runs when a new result is added to the result list. Function to implement: ``on_result``

docs/dev/search_api.rst

@@ -1,13 +1,20 @@
 Search API
 ==========
 
-Search API endpoints: ``/``, ``/search``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The search supports both ``GET`` and ``POST``. However, using ``GET`` the parameters of the request remain hidden. So it is advised to use ``GET`` for querying.
 
-Endpoints have equivalent functionality.
+Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
+
+.. code:: sh
+
+    GET /
+
+.. code:: sh
+
+    GET /search
 
 Parameters
-^^^^^^^^^^
+``````````
 
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
 | Name             | Description                                                                                        |                             |
@@ -18,7 +25,7 @@ Parameters
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
 | ``engines``      | Comma separated list, specifies the active search engines                                          | optional                    |
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
+| ``lang``         | Code of the language                                                                               | optional (default: ``all``) |
++------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
 | ``pageno``       | Search page number                                                                                 | optional (default: ``1``)   |
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
-
-Both ``GET`` and ``POST`` methods are supported.

docs/index.rst

@@ -1,7 +1,7 @@
-Privacy-respecting free metasearch engine
-=========================================
+Welcome to searx
+================
 
-Searx is a free software internet metasearch engine which aggregates results from other search engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
+Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
 
 
 Features
@@ -15,16 +15,26 @@ Features
  - Does not collect its users data
  - Offers secure, encrypted connections (HTTPS/SSL)
  - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
+ - About 70 supported search engines
+ - Easy intergration with any search engine
 
 
-Further reading
----------------
+User documentation
+------------------
 
 .. toctree::
    :maxdepth: 1
 
    user/search_syntax
 
+Administrator documentation
+---------------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   dev/install/installation
+   admin/api
 
 Developer documentation
 -----------------------
@@ -34,7 +44,6 @@ Developer documentation
 
    dev/quickstart
    dev/contribution_guide
-   dev/install/installation
    dev/engine_overview
    dev/search_api
    dev/plugins

genindex.html

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Index &mdash; searx 0.8.0 documentation</title>
+    <title>Index &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="index.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="index.html" />
    
   
   <link media="only screen and (max-device-width: 480px)" href="_static/small_flask.css" type= "text/css" rel="stylesheet" />
@@ -73,7 +73,7 @@
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

index.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Privacy-respecting free metasearch engine &mdash; searx 0.8.0 documentation</title>
+    <title>Welcome to searx &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,7 +23,7 @@
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="#" />
+    <link rel="top" title="searx 0.9.0 documentation" href="#" />
     <link rel="next" title="Search syntax" href="user/search_syntax.html" />
    
   
@@ -38,9 +38,9 @@
         <div class="bodywrapper">
           <div class="body" role="main">
             
-  <div class="section" id="privacy-respecting-free-metasearch-engine">
-<h1>Privacy-respecting free metasearch engine<a class="headerlink" href="#privacy-respecting-free-metasearch-engine" title="Permalink to this headline">¶</a></h1>
-<p>Searx is a free software internet metasearch engine which aggregates results from other search engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users&#8217; data with third parties. Additionally, searx can be used over Tor for online anonymity.</p>
+  <div class="section" id="welcome-to-searx">
+<h1>Welcome to searx<a class="headerlink" href="#welcome-to-searx" title="Permalink to this headline">¶</a></h1>
+<p>Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users&#8217; data with third parties. Additionally, searx can be used over Tor for online anonymity.</p>
 <div class="section" id="features">
 <h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
 <blockquote>
@@ -53,24 +53,34 @@
 <li>Does not collect its users data</li>
 <li>Offers secure, encrypted connections (HTTPS/SSL)</li>
 <li>Hosted by organisations, such as La Quadrature du Net, which promote digital rights</li>
+<li>About 70 supported search engines</li>
+<li>Easy intergration with any search engine</li>
 </ul>
 </div></blockquote>
 </div>
-<div class="section" id="further-reading">
-<h2>Further reading<a class="headerlink" href="#further-reading" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="user-documentation">
+<h2>User documentation<a class="headerlink" href="#user-documentation" title="Permalink to this headline">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="user/search_syntax.html">Search syntax</a></li>
 </ul>
 </div>
 </div>
+<div class="section" id="administrator-documentation">
+<h2>Administrator documentation<a class="headerlink" href="#administrator-documentation" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="admin/api.html">Administration API</a></li>
+</ul>
+</div>
+</div>
 <div class="section" id="developer-documentation">
 <h2>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="dev/quickstart.html">Development Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="dev/contribution_guide.html">How to contribute</a></li>
-<li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="dev/engine_overview.html">Engine overview</a></li>
 <li class="toctree-l1"><a class="reference internal" href="dev/search_api.html">Search API</a></li>
 <li class="toctree-l1"><a class="reference internal" href="dev/plugins.html">Plugins</a></li>
@@ -105,7 +115,7 @@
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

search.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Search &mdash; searx 0.8.0 documentation</title>
+    <title>Search &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="_static/style.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    './',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -24,7 +24,7 @@
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
     <script type="text/javascript" src="_static/searchtools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="index.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="index.html" />
   <script type="text/javascript">
     jQuery(function() { Search.loadIndex("searchindex.js"); });
   </script>
@@ -93,7 +93,7 @@
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>

user/search_syntax.html

@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     
-    <title>Search syntax &mdash; searx 0.8.0 documentation</title>
+    <title>Search syntax &mdash; searx 0.9.0 documentation</title>
     
     <link rel="stylesheet" href="../_static/style.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../',
-        VERSION:     '0.8.0',
+        VERSION:     '0.9.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -23,8 +23,8 @@
     <script type="text/javascript" src="../_static/jquery.js"></script>
     <script type="text/javascript" src="../_static/underscore.js"></script>
     <script type="text/javascript" src="../_static/doctools.js"></script>
-    <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
-    <link rel="next" title="How to contribute" href="../dev/contribution_guide.html" />
+    <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
+    <link rel="next" title="Installation" href="../dev/install/installation.html" />
     <link rel="prev" title="Privacy-respecting free metasearch engine" href="../index.html" />
    
   
@@ -90,7 +90,7 @@ list of engines, categories and languages.</p>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy; Copyright 2015, Adam Tauber.
+      &copy; Copyright 2015-2016, Adam Tauber.
     </div>
   </body>
 </html>