index.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. .. _engine implementations:
  2. ======================
  3. Engine Implementations
  4. ======================
  5. .. contents::
  6. :depth: 2
  7. :local:
  8. :backlinks: entry
  9. .. toctree::
  10. :caption: Framework Components
  11. :maxdepth: 2
  12. enginelib
  13. engines
  14. engine_overview
  15. ResultList and engines
  16. ======================
  17. .. autoclass:: searx.result_types.ResultList
  18. .. autoclass:: searx.result_types.EngineResults
  19. Engine Types
  20. ============
  21. The :py:obj:`engine_type <searx.enginelib.Engine.engine_type>` of an engine
  22. determines which :ref:`search processor <searx.search.processors>` is used by
  23. the engine.
  24. In this section a list of the engines that are documented is given, a complete
  25. list of the engines can be found in the source under: :origin:`searx/engines`.
  26. .. _online engines:
  27. Online Engines
  28. --------------
  29. .. sidebar:: info
  30. - :py:obj:`processors.online <searx.search.processors.online>`
  31. .. toctree::
  32. :maxdepth: 1
  33. :glob:
  34. demo/demo_online
  35. xpath
  36. mediawiki
  37. json_engine
  38. .. toctree::
  39. :maxdepth: 1
  40. :glob:
  41. online/*
  42. .. _offline engines:
  43. Offline Engines
  44. ---------------
  45. .. sidebar:: info
  46. - :py:obj:`processors.offline <searx.search.processors.offline>`
  47. .. toctree::
  48. :maxdepth: 1
  49. :glob:
  50. offline_concept
  51. demo/demo_offline
  52. offline/*
  53. .. _online url search:
  54. Online URL Search
  55. -----------------
  56. .. sidebar:: info
  57. - :py:obj:`processors.online_url_search <searx.search.processors.online_url_search>`
  58. .. toctree::
  59. :maxdepth: 1
  60. :glob:
  61. online_url_search/*
  62. .. _online currency:
  63. Online Currency
  64. ---------------
  65. .. sidebar:: info
  66. - :py:obj:`processors.online_currency <searx.search.processors.online_currency>`
  67. *no engine of this type is documented yet / coming soon*
  68. .. _online dictionary:
  69. Online Dictionary
  70. -----------------
  71. .. sidebar:: info
  72. - :py:obj:`processors.online_dictionary <searx.search.processors.online_dictionary>`
  73. *no engine of this type is documented yet / coming soon*