Browse Source

[doc] fix tyops in docs/dev/reST.rst

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Markus Heiser 2 years ago
parent
commit
68a0e1bfc3
1 changed files with 8 additions and 6 deletions
  1. 8 6
      docs/dev/reST.rst

+ 8 - 6
docs/dev/reST.rst

@@ -10,13 +10,15 @@ reST primer
    contributors to follow principles like KISS_ and readability_.
    contributors to follow principles like KISS_ and readability_.
 
 
 We at SearXNG are using reStructuredText (aka reST_) markup for all kind of
 We at SearXNG are using reStructuredText (aka reST_) markup for all kind of
-documentation, with the builders from the Sphinx_ project a HTML output is
+documentation.  With the builders from the Sphinx_ project a HTML output is
-generated and deployed at :docs:`github.io <.>`.  For build prerequisites read
+generated and deployed at docs.searxng.org_.  For build prerequisites read
 :ref:`docs build`.
 :ref:`docs build`.
 
 
-The source files of Searx's documentation are located at :origin:`docs`.  Sphinx
+.. _docs.searxng.org: https://docs.searxng.org/
-assumes source files to be encoded in UTF-8 by default.  Run :ref:`make docs.live
+
-<make docs.live>` to build HTML while editing.
+The source files of SearXNG's documentation are located at :origin:`docs`.
+Sphinx 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
 .. sidebar:: Further reading
 
 
@@ -494,7 +496,7 @@ Figures & Images
    is flexible.  To get best results in the generated output format, install
    is flexible.  To get best results in the generated output format, install
    ImageMagick_ and Graphviz_.
    ImageMagick_ and Graphviz_.
 
 
-Searx's sphinx setup includes: :ref:`linuxdoc:kfigure`.  Scalable here means;
+SearXNG's sphinx setup includes: :ref:`linuxdoc:kfigure`.  Scalable here means;
 scalable in sense of the build process.  Normally in absence of a converter
 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
 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
 about the build process when handling with images, especially since he has no