summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2020-01-08 18:09:36 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2020-01-08 18:09:36 +0100
commitbdf392093af92da7d8fc4e32b68ff0716700522d (patch)
treee2ec39ab388e27e804a022bfee4a1438adfa226c /docs/dev
parent22d05b3e596029738eba432e11015f8c03c85312 (diff)
downloadsearxng-bdf392093af92da7d8fc4e32b68ff0716700522d.tar.gz
searxng-bdf392093af92da7d8fc4e32b68ff0716700522d.zip
build requirements: add a shell script static analysis tool
ShellCheck: https://github.com/koalaman/shellcheck Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/makefile.rst4
-rw-r--r--docs/dev/reST.rst5
2 files changed, 5 insertions, 4 deletions
diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst
index f5957001c..8e54aef48 100644
--- a/docs/dev/makefile.rst
+++ b/docs/dev/makefile.rst
@@ -11,6 +11,8 @@ Makefile Targets
Before looking deeper at the targets, first read about :ref:`makefile setup`
and :ref:`make pyenv`.
+ To install system requirements follow :ref:`buildhosts`.
+
With the aim to simplify development cycles, started with :pull:`1756` a
``Makefile`` based boilerplate was added. If you are not familiar with
Makefiles, we recommend to read gnu-make_ introduction.
@@ -170,7 +172,7 @@ e.g.:
.. code:: sh
- $ make test.pep8 test.unit
+ $ make test.pep8 test.unit test.sh
. ./local/py3/bin/activate; ./manage.sh pep8_check
[!] Running pep8 check
. ./local/py3/bin/activate; ./manage.sh unit_tests
diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst
index 4dc1279f0..7c82ebe5a 100644
--- a/docs/dev/reST.rst
+++ b/docs/dev/reST.rst
@@ -1312,9 +1312,8 @@ others are basic-tabs_ and code-tabs_. Below a *group-tab* example from
.. literalinclude:: ../admin/buildhosts.rst
:language: reST
- :start-after: .. _system requirements:
- :end-before: .. _system requirements END:
-
+ :start-after: .. SNIP sh lint requirements
+ :end-before: .. SNAP sh lint requirements
.. _math: