diff options
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/engine_overview.rst | 6 | ||||
| -rw-r--r-- | docs/dev/lxcdev.rst | 6 | ||||
| -rw-r--r-- | docs/dev/reST.rst | 16 | ||||
| -rw-r--r-- | docs/dev/search_api.rst | 4 |
4 files changed, 16 insertions, 16 deletions
diff --git a/docs/dev/engine_overview.rst b/docs/dev/engine_overview.rst index efe9d7bf3..95ed267e2 100644 --- a/docs/dev/engine_overview.rst +++ b/docs/dev/engine_overview.rst @@ -47,7 +47,7 @@ Engine File argument type information ======================= =========== ======================================================== categories list pages, in which the engine is working - paging boolean support multible pages + paging boolean support multiple pages time_range_support boolean support search time range engine_type str - ``online`` :ref:`[ref] <demo online engine>` by default, other possibles values are: @@ -386,11 +386,11 @@ the parameter ``template`` must be set to the desired type. - DOI number (like ``10.1038/d41586-018-07848-2``) * - issn - - :py:class:`str` + - :py:class:`List <list>`\ [\ :py:class:`str`\ ] - ISSN number like ``1476-4687`` * - isbn - - :py:class:`str` + - :py:class:`List <list>`\ [\ :py:class:`str`\ ] - ISBN number like ``9780201896831`` * - pdf_url diff --git a/docs/dev/lxcdev.rst b/docs/dev/lxcdev.rst index 6195a575d..6688c21f0 100644 --- a/docs/dev/lxcdev.rst +++ b/docs/dev/lxcdev.rst @@ -202,7 +202,7 @@ To debug services from filtron and morty analogous use: Another point we have to notice is that the service (:ref:`SearXNG <searxng.sh>` runs under dedicated system user account with the same name (compare -:ref:`create searxng user`). To get a shell from theses accounts, simply call: +:ref:`create searxng user`). To get a shell from these accounts, simply call: .. tabs:: @@ -300,7 +300,7 @@ of the container: Now we can develop as usual in the working tree of our desktop system. Every time the software was changed, you have to restart the SearXNG service (in the -conatiner): +container): .. tabs:: @@ -359,7 +359,7 @@ We build up a fully functional SearXNG suite in a archlinux container: $ sudo -H ./utils/lxc.sh install suite searxng-archlinux To access HTTP from the desktop we installed nginx for the services inside the -conatiner: +container: .. tabs:: diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index 70d08adb5..e5d49f672 100644 --- a/docs/dev/reST.rst +++ b/docs/dev/reST.rst @@ -15,7 +15,7 @@ generated and deployed at :docs:`github.io <.>`. For build prerequisites read :ref:`docs build`. The source files of Searx's documentation are located at :origin:`docs`. Sphinx -assumes source files to be encoded in UTF-8 by defaul. Run :ref:`make docs.live +assumes source files to be encoded in UTF-8 by default. Run :ref:`make docs.live <make docs.live>` to build HTML while editing. .. sidebar:: Further reading @@ -227,13 +227,13 @@ To refer anchors use the `ref role`_ markup: .. code:: reST - Visit chapter :ref:`reST anchor`. Or set hyperlink text manualy :ref:`foo + Visit chapter :ref:`reST anchor`. Or set hyperlink text manually :ref:`foo bar <reST anchor>`. .. admonition:: ``:ref:`` role :class: rst-example - Visist chapter :ref:`reST anchor`. Or set hyperlink text manualy :ref:`foo + Visist chapter :ref:`reST anchor`. Or set hyperlink text manually :ref:`foo bar <reST anchor>`. .. _reST ordinary ref: @@ -494,8 +494,8 @@ Figures & Images is flexible. To get best results in the generated output format, install ImageMagick_ and Graphviz_. -Searx's sphinx setup includes: :ref:`linuxdoc:kfigure`. Scaleable here means; -scaleable in sense of the build process. Normally in absence of a converter +Searx's sphinx setup includes: :ref:`linuxdoc:kfigure`. Scalable here means; +scalable in sense of the build process. Normally in absence of a converter tool, the build process will break. From the authors POV it’s annoying to care about the build process when handling with images, especially since he has no access to the build process. With :ref:`linuxdoc:kfigure` the build process @@ -503,7 +503,7 @@ continues and scales output quality in dependence of installed image processors. If you want to add an image, you should use the ``kernel-figure`` (inheritance of :dudir:`figure`) and ``kernel-image`` (inheritance of :dudir:`image`) -directives. E.g. to insert a figure with a scaleable image format use SVG +directives. E.g. to insert a figure with a scalable image format use SVG (:ref:`svg image example`): .. code:: reST @@ -1185,7 +1185,7 @@ and *targets* (e.g. a ref to :ref:`row 2 of table's body <row body 2>`). - cell 4.4 * - row 5 - - cell 5.1 with automatic span to rigth end + - cell 5.1 with automatic span to right end * - row 6 - cell 6.1 @@ -1237,7 +1237,7 @@ and *targets* (e.g. a ref to :ref:`row 2 of table's body <row body 2>`). - cell 4.4 * - row 5 - - cell 5.1 with automatic span to rigth end + - cell 5.1 with automatic span to right end * - row 6 - cell 6.1 diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst index 3a56b9991..2333474a9 100644 --- a/docs/dev/search_api.rst +++ b/docs/dev/search_api.rst @@ -93,14 +93,14 @@ Parameters :default: ``Hash_plugin``, ``Search_on_category_select``, - ``Self_Informations``, ``Tracker_URL_remover``, + ``Self_Information``, ``Tracker_URL_remover``, ``Ahmia_blacklist`` :values: .. enabled by default ``Hash_plugin``, ``Search_on_category_select``, - ``Self_Informations``, ``Tracker_URL_remover``, + ``Self_Information``, ``Tracker_URL_remover``, ``Ahmia_blacklist``, .. disabled by default |