git.iko.soy/searx
on master help sign in
edoc: -- makefile.rst fix typo and add extlinks['man']
2b45269Markus Heiser
docs/conf.py+1
compare with master
unifiedsplit
@@ -33,6 +33,7 @@ extlinks['patch'] = (GIT_URL + '/commit/%s', '#')
33extlinks['search'] = (SEARX_URL + '/%s', '#')
33extlinks['search'] = (SEARX_URL + '/%s', '#')
34extlinks['docs'] = (DOCS_URL + '/%s', 'docs: ')
34extlinks['docs'] = (DOCS_URL + '/%s', 'docs: ')
35extlinks['pypi'] = ('https://pypi.org/project/%s', 'PyPi: ')
35extlinks['pypi'] = ('https://pypi.org/project/%s', 'PyPi: ')
36+extlinks['man'] = ('https://manpages.debian.org/jump?q=%s', '')
36
37
37extensions = [
38extensions = [
38 'sphinx.ext.extlinks',
39 'sphinx.ext.extlinks',
docs/dev/makefile.rst+8−4
@@ -4,13 +4,16 @@
4Makefile Targets
4Makefile Targets
5================
5================
6
6
7+.. _gnu-make: https://www.gnu.org/software/make/manual/make.html#Introduction
8+
7.. sidebar:: build environment
9.. sidebar:: build environment
8
10
9 Before looking deeper at the targets, first read about :ref:`makefile setup`
11 Before looking deeper at the targets, first read about :ref:`makefile setup`
10 and :ref:`make pyenv`.
12 and :ref:`make pyenv`.
11
13
12With the aim to simplify development cycles, started with :pull:`1756` a
14With 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.
14
17
15The usage is simple, just type ``make {target-name}`` to *build* a target.
18The usage is simple, just type ``make {target-name}`` to *build* a target.
16Calling the ``help`` target gives a first overview::
19Calling the ``help`` target gives a first overview::
@@ -77,7 +80,7 @@ and release a ``make pyenv``:
77 ...
80 ...
78
81
79With target ``pyenv`` a development environment (aka virtualenv) was build up in
82With 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`)
81into this environment make target ``install``
84into this environment make target ``install``
82
85
83.. code:: sh
86.. code:: sh
@@ -108,8 +111,9 @@ the :origin:`setup.py` file (or the requirements listed in
108============
111============
109
112
110To get up a running a developer instance simply call ``make run``. This enables
113To 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``
114+*debug* option in :origin:`searx/settings.yml`, starts a ``./searx/webapp.py``
112−instance, disables *debug* option and opens the site (xdg-open):
115+instance, disables *debug* option again and opens the URL in your favorite WEB
116+browser (:man:`xdg-open`):
113
117
114.. code:: sh
118.. code:: sh
115
119