diff options
author | Markus Heiser <markus.heiser@darmarit.de> | 2019-12-18 18:32:42 +0100 |
---|---|---|
committer | Markus Heiser <markus.heiser@darmarit.de> | 2019-12-18 18:32:42 +0100 |
commit | 2b4526916dd8092191baa5b9387e8198e5072b83 (patch) | |
tree | bfc181fa9a7d72b2ea4fd444f632b88830178533 /docs/dev/makefile.rst | |
parent | f09459b98ae877d7dfd40d85c0edf058c65913d5 (diff) | |
download | searxng-2b4526916dd8092191baa5b9387e8198e5072b83.tar.gz searxng-2b4526916dd8092191baa5b9387e8198e5072b83.zip |
edoc: -- makefile.rst fix typo and add extlinks['man']
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/makefile.rst')
-rw-r--r-- | docs/dev/makefile.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index 65cddd3ee..00825623c 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -4,13 +4,16 @@ Makefile Targets ================ +.. _gnu-make: https://www.gnu.org/software/make/manual/make.html#Introduction + .. sidebar:: build environment Before looking deeper at the targets, first read about :ref:`makefile setup` and :ref:`make pyenv`. With the aim to simplify development cycles, started with :pull:`1756` a -``Makefile`` based boilerplate was added. +``Makefile`` based boilerplate was added. If you are not familiar with +Makefiles, we recommend to read gnu-make_ introduction. The usage is simple, just type ``make {target-name}`` to *build* a target. Calling the ``help`` target gives a first overview:: @@ -77,7 +80,7 @@ and release a ``make pyenv``: ... With target ``pyenv`` a development environment (aka virtualenv) was build up in -``./local/py3/``. To make a *developer install** of searx (:origin:`setup.py`) +``./local/py3/``. To make a *developer install* of searx (:origin:`setup.py`) into this environment make target ``install`` .. code:: sh @@ -108,8 +111,9 @@ the :origin:`setup.py` file (or the requirements listed in ============ To get up a running a developer instance simply call ``make run``. This enables -*debug* option in :origin:`searx/settings.yml`, starts ``./searx/webapp.py`` -instance, disables *debug* option and opens the site (xdg-open): +*debug* option in :origin:`searx/settings.yml`, starts a ``./searx/webapp.py`` +instance, disables *debug* option again and opens the URL in your favorite WEB +browser (:man:`xdg-open`): .. code:: sh |