2019-12-30 18:31:17 +01:00
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
2020-06-19 11:15:15 +02:00
|
|
|
<html>
|
2019-12-30 18:31:17 +01:00
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
2020-09-30 10:35:05 +02:00
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
2019-12-30 18:31:17 +01:00
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
2021-03-27 20:39:04 +01:00
|
|
|
<title>Developer documentation — Searx Documentation (Searx-1.0.0.tex)</title>
|
2019-12-30 18:31:17 +01:00
|
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
2021-01-05 16:45:49 +01:00
|
|
|
<link rel="stylesheet" href="../_static/searx.css" type="text/css" />
|
2021-02-17 20:54:37 +01:00
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
|
2020-02-15 10:08:58 +01:00
|
|
|
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
|
|
|
<script src="../_static/jquery.js"></script>
|
|
|
|
|
<script src="../_static/underscore.js"></script>
|
|
|
|
|
<script src="../_static/doctools.js"></script>
|
2019-12-30 18:31:17 +01:00
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
|
|
|
<link rel="next" title="Development Quickstart" href="quickstart.html" />
|
|
|
|
|
<link rel="prev" title="Buildhosts" href="../admin/buildhosts.html" />
|
|
|
|
|
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '../';</script>
|
|
|
|
|
|
|
|
|
|
</head><body>
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
|
|
accesskey="I">index</a></li>
|
2020-11-04 14:12:59 +01:00
|
|
|
<li class="right" >
|
|
|
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
|
|
|
>modules</a> |</li>
|
2019-12-30 18:31:17 +01:00
|
|
|
<li class="right" >
|
|
|
|
|
<a href="quickstart.html" title="Development Quickstart"
|
|
|
|
|
accesskey="N">next</a> |</li>
|
|
|
|
|
<li class="right" >
|
|
|
|
|
<a href="../admin/buildhosts.html" title="Buildhosts"
|
|
|
|
|
accesskey="P">previous</a> |</li>
|
2021-03-27 20:39:04 +01:00
|
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-1.0.0.tex)</a> »</li>
|
2020-09-30 10:35:05 +02:00
|
|
|
<li class="nav-item nav-item-this"><a href="">Developer documentation</a></li>
|
2019-12-30 18:31:17 +01:00
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="document">
|
|
|
|
|
<div class="documentwrapper">
|
|
|
|
|
<div class="bodywrapper">
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
2021-04-08 19:47:22 +02:00
|
|
|
<div class="section" id="developer-documentation">
|
2019-12-30 18:31:17 +01:00
|
|
|
<h1>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline">¶</a></h1>
|
|
|
|
|
<div class="toctree-wrapper compound">
|
2021-04-08 19:47:22 +02:00
|
|
|
<p class="caption"><span class="caption-text">Contents</span></p>
|
2019-12-30 18:31:17 +01:00
|
|
|
<ul>
|
2020-12-14 18:19:24 +01:00
|
|
|
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Development Quickstart</a></li>
|
2020-06-19 11:15:15 +02:00
|
|
|
<li class="toctree-l1"><a class="reference internal" href="contribution_guide.html">How to contribute</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#prime-directives-privacy-hackability">Prime directives: Privacy, Hackability</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#code">Code</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#translation">Translation</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#documentation">Documentation</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="engine_overview.html">Engine overview</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="engine_overview.html#general-engine-configuration">general engine configuration</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="engine_overview.html#making-a-request">making a request</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="engine_overview.html#returned-results">returned results</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="search_api.html">Search API</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="search_api.html#parameters">Parameters</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="plugins.html#example-plugin">Example plugin</a></li>
|
2020-09-02 00:33:07 +02:00
|
|
|
<li class="toctree-l2"><a class="reference internal" href="plugins.html#external-plugins">External plugins</a></li>
|
2020-07-25 18:33:36 +02:00
|
|
|
<li class="toctree-l2"><a class="reference internal" href="plugins.html#register-your-plugin">Register your plugin</a></li>
|
2020-06-19 11:15:15 +02:00
|
|
|
<li class="toctree-l2"><a class="reference internal" href="plugins.html#plugin-entry-points">Plugin entry points</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="translation.html#requirements">Requirements</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="translation.html#init-transifex-project">Init Transifex project</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="translation.html#update-translations">Update translations</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="makefile.html">Makefile Targets</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#python-environment">Python environment</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-run"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">run</span></code></a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-clean"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">clean</span></code></a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-docs-docs-live-docs-clean"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs</span> <span class="pre">docs-live</span> <span class="pre">docs-clean</span></code></a></li>
|
2020-12-27 09:50:37 +01:00
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-books-name-html-books-name-pdf"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">books/{name}.html</span> <span class="pre">books/{name}.pdf</span></code></a></li>
|
2020-06-19 11:15:15 +02:00
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-gh-pages"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">gh-pages</span></code></a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-test"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test</span></code></a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-pylint"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">pylint</span></code></a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="makefile.html#make-pybuild"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">pybuild</span></code></a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="reST.html">reST primer</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#soft-skills">Soft skills</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#basic-inline-markup">Basic inline markup</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#basic-article-structure">Basic article structure</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#anchors-links">Anchors & Links</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#literal-blocks">Literal blocks</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#unicode-substitution">Unicode substitution</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#roles">Roles</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#figures-images">Figures & Images</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#list-markups">List markups</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#admonitions">Admonitions</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#tables">Tables</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#templating">Templating</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#tabbed-views">Tabbed views</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="reST.html#math-equations">Math equations</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2019-12-30 18:31:17 +01:00
|
|
|
</ul>
|
|
|
|
|
</div>
|
2021-04-08 19:47:22 +02:00
|
|
|
</div>
|
2019-12-30 18:31:17 +01:00
|
|
|
|
|
|
|
|
|
2020-09-30 10:35:05 +02:00
|
|
|
<div class="clearer"></div>
|
2019-12-30 18:31:17 +01:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<span id="sidebar-top"></span>
|
|
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="logo"><a href="../index.html">
|
|
|
|
|
<img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
|
|
|
|
|
</a></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Project Links</h3>
|
|
|
|
|
<ul>
|
2020-09-30 10:35:05 +02:00
|
|
|
<li><a href="https://github.com/searx/searx">Source</a>
|
2019-12-30 18:31:17 +01:00
|
|
|
|
2020-09-30 10:35:05 +02:00
|
|
|
<li><a href="https://github.com/searx/searx/wiki">Wiki</a>
|
2019-12-30 18:31:17 +01:00
|
|
|
|
2021-01-12 10:55:12 +01:00
|
|
|
<li><a href="https://searx.space">Public instances</a>
|
2019-12-30 18:31:17 +01:00
|
|
|
|
|
|
|
|
<li><a href="https://twitter.com/Searx_engine">Twitter</a>
|
2021-01-12 10:55:12 +01:00
|
|
|
|
|
|
|
|
<li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
|
2019-12-30 18:31:17 +01:00
|
|
|
</ul><h3>Navigation</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="../index.html">Overview</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Previous: <a href="../admin/buildhosts.html" title="previous chapter">Buildhosts</a>
|
|
|
|
|
<li>Next: <a href="quickstart.html" title="next chapter">Development Quickstart</a>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<div id="searchbox" style="display: none" role="search">
|
|
|
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
|
|
|
<div class="searchformwrapper">
|
|
|
|
|
<form class="search" action="../search.html" method="get">
|
|
|
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
|
|
|
<input type="submit" value="Go" />
|
|
|
|
|
</form>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2020-02-15 10:08:58 +01:00
|
|
|
<script>$('#searchbox').show(0);</script>
|
2019-12-30 18:31:17 +01:00
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="clearer"></div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
2020-02-20 19:32:55 +01:00
|
|
|
© Copyright 2015-2020, Adam Tauber, Noémi Ványi.
|
2021-04-21 18:14:58 +02:00
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.3.
|
2019-12-30 18:31:17 +01:00
|
|
|
</div>
|
2020-02-15 10:08:58 +01:00
|
|
|
<script src="../_static/version_warning_offset.js"></script>
|
2019-12-30 18:31:17 +01:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
