From 64100db9045ec712afbd8fa1becee14f7109921c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 6 Aug 2023 16:39:00 +0200 Subject: [doc] improve documentation of make targets and ./manage script BTW force modularization of the ./mange script into sub modules: - utils/lib_sxng_data.sh - utils/lib_sxng_node.sh - utils/lib_sxng_static.sh - utils/lib_sxng_test.sh - utils/lib_sxng_themes.sh Signed-off-by: Markus Heiser --- docs/admin/buildhosts.rst | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) (limited to 'docs/admin/buildhosts.rst') diff --git a/docs/admin/buildhosts.rst b/docs/admin/buildhosts.rst index d31e4b79b..b7f317f74 100644 --- a/docs/admin/buildhosts.rst +++ b/docs/admin/buildhosts.rst @@ -4,22 +4,30 @@ Buildhosts ========== -.. sidebar:: This article needs some work - - If you have any contribution send us your :pull:`PR <../pulls>`, see - :ref:`how to contribute`. - .. contents:: :depth: 2 :local: :backlinks: entry -To get best results from build, it's recommend to install additional packages -on build hosts (see :ref:`searxng.sh`).:: +To get best results from build, it's recommend to install additional packages on +build hosts (see :ref:`searxng.sh`). + +.. _searxng.sh install buildhost: + +Build and Development tools +=========================== + +To Install tools used by build and development tasks in once: + +.. tabs:: + + .. group-tab:: SearXNG's development tools + + .. code:: sh - sudo -H ./utils/searxng.sh install buildhost + $ sudo -H ./utils/searxng.sh install buildhost -This will install packages needed by searx: +This will install packages needed by SearXNG: .. kernel-include:: $DOCS_BUILD/includes/searxng.rst :start-after: START distro-packages @@ -73,7 +81,7 @@ If your docs build (``make docs.html``) shows warnings like this:: display), check the imgmath_latex setting you need to install additional packages on your build host, to get better HTML -output. +output (:ref:`install buildhost `). .. tabs:: @@ -93,7 +101,7 @@ output. .. code-block:: sh - $ sudo dnf install graphviz graphviz-gd texlive-xetex-bin librsvg2-tools + $ sudo dnf install graphviz graphviz-gd ImageMagick texlive-xetex-bin librsvg2-tools For PDF output you also need: @@ -117,9 +125,8 @@ For PDF output you also need: .. code:: sh $ sudo dnf install \ - texlive-collection-fontsrecommended texlive-collection-latex \ - dejavu-sans-fonts dejavu-serif-fonts dejavu-sans-mono-fonts \ - ImageMagick + texlive-collection-fontsrecommended texlive-collection-latex \ + dejavu-sans-fonts dejavu-serif-fonts dejavu-sans-mono-fonts .. _sh lint: @@ -128,7 +135,8 @@ Lint shell scripts .. _ShellCheck: https://github.com/koalaman/shellcheck -To lint shell scripts, we use ShellCheck_ - a shell script static analysis tool. +To lint shell scripts we use ShellCheck_ - a shell script static analysis tool +(:ref:`install buildhost `). .. SNIP sh lint requirements -- cgit v1.2.3-54-g00ecf