index.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>Developer documentation &#8212; Searx Documentation (Searx-1.1.0.tex)</title>
  8. <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
  9. <link rel="stylesheet" type="text/css" href="../_static/searx.css" />
  10. <link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
  11. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  12. <script src="../_static/jquery.js"></script>
  13. <script src="../_static/underscore.js"></script>
  14. <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
  15. <script src="../_static/doctools.js"></script>
  16. <script src="../_static/sphinx_highlight.js"></script>
  17. <link rel="index" title="Index" href="../genindex.html" />
  18. <link rel="search" title="Search" href="../search.html" />
  19. <link rel="next" title="Development Quickstart" href="quickstart.html" />
  20. <link rel="prev" title="Buildhosts" href="../admin/buildhosts.html" />
  21. </head><body>
  22. <div class="related" role="navigation" aria-label="related navigation">
  23. <h3>Navigation</h3>
  24. <ul>
  25. <li class="right" style="margin-right: 10px">
  26. <a href="../genindex.html" title="General Index"
  27. accesskey="I">index</a></li>
  28. <li class="right" >
  29. <a href="../py-modindex.html" title="Python Module Index"
  30. >modules</a> |</li>
  31. <li class="right" >
  32. <a href="quickstart.html" title="Development Quickstart"
  33. accesskey="N">next</a> |</li>
  34. <li class="right" >
  35. <a href="../admin/buildhosts.html" title="Buildhosts"
  36. accesskey="P">previous</a> |</li>
  37. <li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-1.1.0.tex)</a> &#187;</li>
  38. <li class="nav-item nav-item-this"><a href="">Developer documentation</a></li>
  39. </ul>
  40. </div>
  41. <div class="document">
  42. <div class="documentwrapper">
  43. <div class="bodywrapper">
  44. <div class="body" role="main">
  45. <section id="developer-documentation">
  46. <h1>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this heading">¶</a></h1>
  47. <div class="toctree-wrapper compound">
  48. <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
  49. <ul>
  50. <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Development Quickstart</a></li>
  51. <li class="toctree-l1"><a class="reference internal" href="contribution_guide.html">How to contribute</a><ul>
  52. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#prime-directives-privacy-hackability">Prime directives: Privacy, Hackability</a></li>
  53. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#code">Code</a></li>
  54. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#translation">Translation</a></li>
  55. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html#documentation">Documentation</a></li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l1"><a class="reference internal" href="engine_overview.html">Engine overview</a><ul>
  59. <li class="toctree-l2"><a class="reference internal" href="engine_overview.html#general-engine-configuration">general engine configuration</a></li>
  60. <li class="toctree-l2"><a class="reference internal" href="engine_overview.html#making-a-request">making a request</a></li>
  61. <li class="toctree-l2"><a class="reference internal" href="engine_overview.html#returned-results">returned results</a></li>
  62. </ul>
  63. </li>
  64. <li class="toctree-l1"><a class="reference internal" href="search_api.html">Search API</a><ul>
  65. <li class="toctree-l2"><a class="reference internal" href="search_api.html#parameters">Parameters</a></li>
  66. </ul>
  67. </li>
  68. <li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a><ul>
  69. <li class="toctree-l2"><a class="reference internal" href="plugins.html#example-plugin">Example plugin</a></li>
  70. <li class="toctree-l2"><a class="reference internal" href="plugins.html#external-plugins">External plugins</a></li>
  71. <li class="toctree-l2"><a class="reference internal" href="plugins.html#register-your-plugin">Register your plugin</a></li>
  72. <li class="toctree-l2"><a class="reference internal" href="plugins.html#plugin-entry-points">Plugin entry points</a></li>
  73. </ul>
  74. </li>
  75. <li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a><ul>
  76. <li class="toctree-l2"><a class="reference internal" href="translation.html#requirements">Requirements</a></li>
  77. <li class="toctree-l2"><a class="reference internal" href="translation.html#init-transifex-project">Init Transifex project</a></li>
  78. <li class="toctree-l2"><a class="reference internal" href="translation.html#update-translations">Update translations</a></li>
  79. </ul>
  80. </li>
  81. <li class="toctree-l1"><a class="reference internal" href="makefile.html">Makefile</a><ul>
  82. <li class="toctree-l2"><a class="reference internal" href="makefile.html#python-environment">Python environment</a></li>
  83. <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>
  84. <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>
  85. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-docs-docs-autobuild-docs-clean"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs</span> <span class="pre">docs.autobuild</span> <span class="pre">docs.clean</span></code></a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-docs-gh-pages"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">docs.gh-pages</span></code></a></li>
  87. <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>
  88. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-test-sh"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test.sh</span></code></a></li>
  89. <li class="toctree-l2"><a class="reference internal" href="makefile.html#make-test-pylint"><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test.pylint</span></code></a></li>
  90. <li class="toctree-l2"><a class="reference internal" href="makefile.html#search-checker-engine-name"><code class="docutils literal notranslate"><span class="pre">search.checker.{engine</span> <span class="pre">name}</span></code></a></li>
  91. <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>
  92. </ul>
  93. </li>
  94. <li class="toctree-l1"><a class="reference internal" href="reST.html">reST primer</a><ul>
  95. <li class="toctree-l2"><a class="reference internal" href="reST.html#soft-skills">Soft skills</a></li>
  96. <li class="toctree-l2"><a class="reference internal" href="reST.html#basic-inline-markup">Basic inline markup</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="reST.html#basic-article-structure">Basic article structure</a></li>
  98. <li class="toctree-l2"><a class="reference internal" href="reST.html#anchors-links">Anchors &amp; Links</a></li>
  99. <li class="toctree-l2"><a class="reference internal" href="reST.html#literal-blocks">Literal blocks</a></li>
  100. <li class="toctree-l2"><a class="reference internal" href="reST.html#unicode-substitution">Unicode substitution</a></li>
  101. <li class="toctree-l2"><a class="reference internal" href="reST.html#roles">Roles</a></li>
  102. <li class="toctree-l2"><a class="reference internal" href="reST.html#figures-images">Figures &amp; Images</a></li>
  103. <li class="toctree-l2"><a class="reference internal" href="reST.html#list-markups">List markups</a></li>
  104. <li class="toctree-l2"><a class="reference internal" href="reST.html#admonitions">Admonitions</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="reST.html#tables">Tables</a></li>
  106. <li class="toctree-l2"><a class="reference internal" href="reST.html#templating">Templating</a></li>
  107. <li class="toctree-l2"><a class="reference internal" href="reST.html#tabbed-views">Tabbed views</a></li>
  108. <li class="toctree-l2"><a class="reference internal" href="reST.html#math-equations">Math equations</a></li>
  109. </ul>
  110. </li>
  111. </ul>
  112. </div>
  113. </section>
  114. <div class="clearer"></div>
  115. </div>
  116. </div>
  117. </div>
  118. <span id="sidebar-top"></span>
  119. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  120. <div class="sphinxsidebarwrapper">
  121. <p class="logo"><a href="../index.html">
  122. <img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
  123. </a></p>
  124. <h3>Project Links</h3>
  125. <ul>
  126. <li><a href="https://searx.github.io/searx/blog/index.html">Blog</a>
  127. <li><a href="https://github.com/searx/searx">Source</a>
  128. <li><a href="https://github.com/searx/searx/wiki">Wiki</a>
  129. <li><a href="https://twitter.com/Searx_engine">Twitter</a>
  130. <li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
  131. </ul><h3>Navigation</h3>
  132. <ul>
  133. <li><a href="../index.html">Overview</a>
  134. <ul>
  135. <li>Previous: <a href="../admin/buildhosts.html" title="previous chapter">Buildhosts</a>
  136. <li>Next: <a href="quickstart.html" title="next chapter">Development Quickstart</a>
  137. </ul>
  138. </li>
  139. </ul>
  140. <div id="searchbox" style="display: none" role="search">
  141. <h3 id="searchlabel">Quick search</h3>
  142. <div class="searchformwrapper">
  143. <form class="search" action="../search.html" method="get">
  144. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  145. <input type="submit" value="Go" />
  146. </form>
  147. </div>
  148. </div>
  149. <script>document.getElementById('searchbox').style.display = "block"</script>
  150. </div>
  151. </div>
  152. <div class="clearer"></div>
  153. </div>
  154. <div class="footer" role="contentinfo">
  155. &#169; Copyright 2015-2022, Adam Tauber, Noémi Ványi.
  156. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
  157. </div>
  158. <script src="../_static/version_warning_offset.js"></script>
  159. </body>
  160. </html>