doc: make use of sphinx.ext.extlinks & sphinx.ext.intersphinx

- add sphinx extensions
- patch documentation to make use of

These modules help to simplify the reST markup of external references.  BTW it
helps to write more readable reST and form custom brands.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2019-12-04 16:48:36 +01:00
parent 25fa7da6c8
commit af2cae6d1d
6 changed files with 43 additions and 25 deletions

View file

@ -4,30 +4,35 @@ Search syntax
Searx allows you to modify the default categories, engines and search
language via the search query.
Category/engine prefix: ``!``
Prefix ``!``
to set Category/engine
Language prefix: ``:``
Prefix: ``:``
to set language
Prefix to add engines and categories to the currently selected
categories: ``?``
Prefix: ``?``
to add engines and categories to the currently selected categories
Abbrevations of the engines and languages are also accepted.
Engine/category modifiers are chainable and inclusive (e.g. with
`!it !ddg !wp qwer <https://searx.me/?q=%21it%20%21ddg%20%21wp%20qwer>`_
search in IT category **and** duckduckgo **and** wikipedia for ``qwer``).
Abbrevations of the engines and languages are also accepted. Engine/category
modifiers are chainable and inclusive (e.g. with :search:`!it !ddg !wp qwer
<?q=%21it%20%21ddg%20%21wp%20qwer>` search in IT category **and** duckduckgo
**and** wikipedia for ``qwer``).
See the `/preferences page <https://searx.me/preferences>`_ for the
list of engines, categories and languages.
See the :search:`/preferences page <preferences>` for the list of engines,
categories and languages.
Examples
~~~~~~~~
Search in wikipedia for ``qwer``:
`!wp qwer <https://searx.me/?q=%21wp%20qwer>`__ or
`!wikipedia qwer <https://searx.me/?q=%21wikipedia%20qwer>`_
- :search:`!wp qwer <?q=%21wp%20qwer>` or
- :search:`!wikipedia qwer :search:<?q=%21wikipedia%20qwer>`
Image search:
`!images Cthulhu <https://searx.me/?q=%21images%20Cthulhu>`_
- :search:`!images Cthulhu <?q=%21images%20Cthulhu>`
Custom language in wikipedia:
`:hu !wp hackerspace <https://searx.me/?q=%3Ahu%20%21wp%20hackerspace>`_
- :search:`:hu !wp hackerspace <?q=%3Ahu%20%21wp%20hackerspace>`