diff options
| author | Mohamed Elashri <muhammadelashri@gmail.com> | 2022-09-30 23:06:54 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-30 23:06:54 +0000 |
| commit | 8d5653e60d5299979c0de5e55b1c5ca0bee8190c (patch) | |
| tree | 8dc02b7663a5c9c91b09483e4499a612d9823698 /docs/dev/reST.rst | |
| parent | 212c98c9f55dc602f57b4f01a73192450e9782b7 (diff) | |
| parent | 62324655ff0d2e6f234b3e31413877b4b4a7a9fa (diff) | |
Merge branch 'searxng:master' into master
Diffstat (limited to 'docs/dev/reST.rst')
| -rw-r--r-- | docs/dev/reST.rst | 16 |
1 files changed, 8 insertions, 8 deletions
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 |