Browse Source

Merge pull request #956 from kvch/gh-pages

update documentation
Adam Tauber 7 years ago
parent
commit
44174aca8b

+ 2
- 0
_sources/dev/install/installation.txt View File

99
     single-interpreter = true
99
     single-interpreter = true
100
     master = true
100
     master = true
101
     plugin = python
101
     plugin = python
102
+    lazy-apps = true
103
+    enable-threads = true
102
 
104
 
103
     # Module to import
105
     # Module to import
104
     module = searx.webapp
106
     module = searx.webapp

+ 2
- 0
_sources/dev/search_api.txt View File

31
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
31
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
32
 | ``time_range``   | Time range of search                                                                               | optional (possible: ``day``, ``month``, ``year``)|
32
 | ``time_range``   | Time range of search                                                                               | optional (possible: ``day``, ``month``, ``year``)|
33
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
33
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
34
+| ``format``       | Output format of results                                                                           | optional (possible: ``json``, ``csv``, ``rss``)  |
35
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+

+ 7
- 5
dev/quickstart.html View File

109
 </div>
109
 </div>
110
 <div class="section" id="tips-for-debugging-development">
110
 <div class="section" id="tips-for-debugging-development">
111
 <h2>Tips for debugging/development<a class="headerlink" href="#tips-for-debugging-development" title="Permalink to this headline">¶</a></h2>
111
 <h2>Tips for debugging/development<a class="headerlink" href="#tips-for-debugging-development" title="Permalink to this headline">¶</a></h2>
112
-<ol class="arabic simple">
112
+<ol class="arabic">
113
 <li><dl class="first docutils">
113
 <li><dl class="first docutils">
114
 <dt>Turn on debug logging</dt>
114
 <dt>Turn on debug logging</dt>
115
-<dd>Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
115
+<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
116
 to turn on debug logging. When debug logging is enabled a stack trace appears,
116
 to turn on debug logging. When debug logging is enabled a stack trace appears,
117
 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
117
 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
118
-<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>
118
+<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>
119
+</dd>
119
 </dl>
120
 </dl>
120
 </li>
121
 </li>
121
 <li><dl class="first docutils">
122
 <li><dl class="first docutils">
122
 <dt>Run <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> before creating a PR.</dt>
123
 <dt>Run <code class="docutils literal"><span class="pre">./manage.sh</span> <span class="pre">tests</span></code> before creating a PR.</dt>
123
-<dd>Failing build on Travis is common because of PEP8 checks. So a new commit must be created
124
+<dd><p class="first last">Failing build on Travis is common because of PEP8 checks. So a new commit must be created
124
 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
125
 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
125
-locally before creating a PR.</dd>
126
+locally before creating a PR.</p>
127
+</dd>
126
 </dl>
128
 </dl>
127
 </li>
129
 </li>
128
 </ol>
130
 </ol>

+ 4
- 0
dev/search_api.html View File

90
 <td>Time range of search</td>
90
 <td>Time range of search</td>
91
 <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>
91
 <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>
92
 </tr>
92
 </tr>
93
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">format</span></code></td>
94
+<td>Output format of results</td>
95
+<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>
96
+</tr>
93
 </tbody>
97
 </tbody>
94
 </table>
98
 </table>
95
 </div>
99
 </div>

+ 2
- 0
docs/dev/search_api.rst View File

31
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
31
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
32
 | ``time_range``   | Time range of search                                                                               | optional (possible: ``day``, ``month``, ``year``)|
32
 | ``time_range``   | Time range of search                                                                               | optional (possible: ``day``, ``month``, ``year``)|
33
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
33
 +------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
34
+| ``format``       | Output format of results                                                                           | optional (possible: ``json``, ``csv``, ``rss``)  |
35
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+

+ 1
- 1
requirements.txt View File

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

+ 1
- 1
searchindex.js
File diff suppressed because it is too large
View File