git.iko.soy/searx
on engine-data help sign in
searx/docs/admin/buildhosts.rst
155 lines 3.6 kB history raw
1.. _buildhosts:
3==========
4Buildhosts
5==========
7.. sidebar:: This article needs some work
9 If you have any contribution send us your :pull:`PR <../pulls>`, see
10 :ref:`how to contribute`.
12.. contents:: Contents
13 :depth: 2
14 :local:
15 :backlinks: entry
17To get best results from build, its recommend to install additional packages
18on build hosts (see :ref:`searx.sh`).::
20 sudo -H ./utils/searx.sh install buildhost
22This will install packages needed by searx:
24.. kernel-include:: $DOCS_BUILD/includes/searx.rst
25 :start-after: START distro-packages
26 :end-before: END distro-packages
28and packages needed to build docuemtation and run tests:
30.. kernel-include:: $DOCS_BUILD/includes/searx.rst
31 :start-after: START build-packages
32 :end-before: END build-packages
34.. _docs build:
36Build docs
37==========
39.. _Graphviz: https://graphviz.gitlab.io
40.. _ImageMagick: https://www.imagemagick.org
41.. _XeTeX: https://tug.org/xetex/
42.. _dvisvgm: https://dvisvgm.de/
44.. sidebar:: Sphinx build needs
46 - ImageMagick_
47 - Graphviz_
48 - XeTeX_
49 - dvisvgm_
51Most of the sphinx requirements are installed from :origin:`setup.py` and the
52docs can be build from scratch with ``make docs``. For better math and image
53processing additional packages are needed. The XeTeX_ needed not only for PDF
54creation, its also needed for :ref:`math` when HTML output is build.
56To be able to do :ref:`sphinx:math-support` without CDNs, the math are rendered
57as images (``sphinx.ext.imgmath`` extension).
59Here is the extract from the :origin:`docs/conf.py` file, setting math renderer
60to ``imgmath``:
62.. literalinclude:: ../conf.py
63 :language: python
64 :start-after: # sphinx.ext.imgmath setup
65 :end-before: # sphinx.ext.imgmath setup END
67If your docs build (``make docs``) shows warnings like this::
69 WARNING: dot(1) not found, for better output quality install \
70 graphviz from https://www.graphviz.org
71 ..
72 WARNING: LaTeX command 'latex' cannot be run (needed for math \
73 display), check the imgmath_latex setting
75you need to install additional packages on your build host, to get better HTML
76output.
78.. tabs::
80 .. group-tab:: Ubuntu / debian
82 .. code-block:: sh
84 $ sudo apt install graphviz imagemagick texlive-xetex librsvg2-bin
86 .. group-tab:: Arch Linux
88 .. code-block:: sh
90 $ sudo pacman -S graphviz imagemagick texlive-bin extra/librsvg
92 .. group-tab:: Fedora / RHEL
94 .. code-block:: sh
96 $ sudo dnf install graphviz graphviz-gd texlive-xetex-bin librsvg2-tools
99For PDF output you also need:
101.. tabs::
103 .. group-tab:: Ubuntu / debian
105 .. code:: sh
107 $ sudo apt texlive-latex-recommended texlive-extra-utils ttf-dejavu
109 .. group-tab:: Arch Linux
111 .. code:: sh
113 $ sudo pacman -S texlive-core texlive-latexextra ttf-dejavu
115 .. group-tab:: Fedora / RHEL
117 .. code:: sh
119 $ sudo dnf install \
120 texlive-collection-fontsrecommended texlive-collection-latex \
121 dejavu-sans-fonts dejavu-serif-fonts dejavu-sans-mono-fonts \
122 ImageMagick
124.. _sh lint:
126Lint shell scripts
127==================
129.. _ShellCheck: https://github.com/koalaman/shellcheck
131To lint shell scripts, we use ShellCheck_ - A shell script static analysis tool.
133.. SNIP sh lint requirements
135.. tabs::
137 .. group-tab:: Ubuntu / debian
139 .. code-block:: sh
141 $ sudo apt install shellcheck
143 .. group-tab:: Arch Linux
145 .. code-block:: sh
147 $ sudo pacman -S shellcheck
149 .. group-tab:: Fedora / RHEL
151 .. code-block:: sh
153 $ sudo dnf install ShellCheck
155.. SNAP sh lint requirements