on master help sign in
edoc: -- makefile.rst fix typo and add extlinks['man']

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

commit2b4526916dd8092191baa5b9387e8198e5072b83 authorMarkus Heiser <markus.heiser@darmarit.de> dateWed 18 Dec 2019, 18:32 (7 years ago) parentf09459b
2 files changed+9−4
docs/conf.py+1 docs/dev/makefile.rst+8−4
docs/conf.py+1
@@ -33,6 +33,7 @@ extlinks['patch'] = (GIT_URL + '/commit/%s', '#')
3333extlinks['search'] = (SEARX_URL + '/%s', '#')
3434extlinks['docs'] = (DOCS_URL + '/%s', 'docs: ')
3535extlinks['pypi'] = ('https://pypi.org/project/%s', 'PyPi: ')
36+extlinks['man'] = ('https://manpages.debian.org/jump?q=%s', '')
3637
3738extensions = [
3839 'sphinx.ext.extlinks',
docs/dev/makefile.rst+8−4
@@ -4,13 +4,16 @@
44Makefile Targets
55================
66
7+.. _gnu-make: https://www.gnu.org/software/make/manual/make.html#Introduction
8+
79.. sidebar:: build environment
810
911 Before looking deeper at the targets, first read about :ref:`makefile setup`
1012 and :ref:`make pyenv`.
1113
1214With the aim to simplify development cycles, started with :pull:`1756` a
13−``Makefile`` based boilerplate was added.
15+``Makefile`` based boilerplate was added. If you are not familiar with
16+Makefiles, we recommend to read gnu-make_ introduction.
1417
1518The usage is simple, just type ``make {target-name}`` to *build* a target.
1619Calling the ``help`` target gives a first overview::
@@ -77,7 +80,7 @@ and release a ``make pyenv``:
7780 ...
7881
7982With target ``pyenv`` a development environment (aka virtualenv) was build up in
80−``./local/py3/``. To make a *developer install** of searx (:origin:`setup.py`)
83+``./local/py3/``. To make a *developer install* of searx (:origin:`setup.py`)
8184into this environment make target ``install``
8285
8386.. code:: sh
@@ -108,8 +111,9 @@ the :origin:`setup.py` file (or the requirements listed in
108111============
109112
110113To get up a running a developer instance simply call ``make run``. This enables
111−*debug* option in :origin:`searx/settings.yml`, starts ``./searx/webapp.py``
112−instance, disables *debug* option and opens the site (xdg-open):
114+*debug* option in :origin:`searx/settings.yml`, starts a ``./searx/webapp.py``
115+instance, disables *debug* option again and opens the URL in your favorite WEB
116+browser (:man:`xdg-open`):
113117
114118.. code:: sh
115119