diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin/filtron.rst | 2 | ||||
| -rw-r--r-- | docs/dev/index.rst | 1 | ||||
| -rw-r--r-- | docs/dev/makefile.rst | 19 | ||||
| -rw-r--r-- | docs/dev/quickstart.rst | 5 | ||||
| -rw-r--r-- | docs/dev/searxng_extra/index.rst (renamed from docs/searxng_extra/index.rst) | 2 | ||||
| -rw-r--r-- | docs/dev/searxng_extra/standalone_searx.py.rst (renamed from docs/searxng_extra/standalone_searx.py.rst) | 0 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
7 files changed, 20 insertions, 10 deletions
diff --git a/docs/admin/filtron.rst b/docs/admin/filtron.rst index 9587d76cb..f08149ae9 100644 --- a/docs/admin/filtron.rst +++ b/docs/admin/filtron.rst @@ -23,7 +23,7 @@ it is advised to limit the number of requests processed by SearXNG. An application firewall, filtron_ solves exactly this problem. Filtron is just a middleware between your web server (nginx, apache, ...) and searx, we describe -such infratructures in chapter: :ref:`architecture`. +such infrastructures in chapter: :ref:`architecture`. filtron & go diff --git a/docs/dev/index.rst b/docs/dev/index.rst index 93c914bbb..39be0885c 100644 --- a/docs/dev/index.rst +++ b/docs/dev/index.rst @@ -16,3 +16,4 @@ Developer documentation lxcdev makefile reST + searxng_extra/index diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst index 66def0b3a..8c9058c34 100644 --- a/docs/dev/makefile.rst +++ b/docs/dev/makefile.rst @@ -13,7 +13,7 @@ Makefile To install system requirements follow :ref:`buildhosts`. -All relevant build tasks are implemented in :origin:`manage.sh` and for CI or +All relevant build tasks are implemented in :origin:`manage` and for CI or IDE integration a small ``Makefile`` wrapper is available. If you are not familiar with Makefiles, we recommend to read gnu-make_ introduction. @@ -173,14 +173,19 @@ Install latest Node.js_ LTS locally (uses nvm_):: To get up a running a developer instance simply call ``make run``. This enables *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`):: +instance and opens the URL in your favorite WEB browser (:man:`xdg-open`):: $ make run - PYENV OK - SEARXNG_DEBUG=1 ./manage.sh pyenv.cmd python ./searx/webapp.py - ... - INFO:werkzeug: * Running on http://127.0.0.1:8888/ (Press CTRL+C to quit) + +Changes to theme's HTML templates (jinja2) are instant. Changes to the CSS & JS +sources of the theme need to be rebuild. You can do that by running:: + + $ make themes.all + +Alternatively to ``themes.all`` you can run *live builds* of the theme you are +modify:: + + $ LIVE_THEME=simple make run .. _make clean: diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst index d2b666c09..db52a2d80 100644 --- a/docs/dev/quickstart.rst +++ b/docs/dev/quickstart.rst @@ -40,10 +40,15 @@ JavaScript: Alternatively you can also compile selective the theme you have modified, e.g. the *simple* theme. + .. code:: sh make themes.simple +.. tip:: + + To get live builds while modifying CSS & JS use: ``LIVE_THEME=simple make run`` + If you finished your *tests* you can start to commit your changes. To separate the modified source code from the build products first run: diff --git a/docs/searxng_extra/index.rst b/docs/dev/searxng_extra/index.rst index a98c358f2..f38bb3154 100644 --- a/docs/searxng_extra/index.rst +++ b/docs/dev/searxng_extra/index.rst @@ -5,7 +5,7 @@ Tooling box ``searxng_extra`` for developers and users ====================================================== In the folder :origin:`searxng_extra/` we maintain some tools useful for -developers and users. +developers. .. toctree:: :maxdepth: 2 diff --git a/docs/searxng_extra/standalone_searx.py.rst b/docs/dev/searxng_extra/standalone_searx.py.rst index 7cbbccfde..7cbbccfde 100644 --- a/docs/searxng_extra/standalone_searx.py.rst +++ b/docs/dev/searxng_extra/standalone_searx.py.rst diff --git a/docs/index.rst b/docs/index.rst index 7100d4ed1..f9800f95b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,6 @@ If you don't trust anyone, you can set up your own, see :ref:`installation`. user/index admin/index dev/index - searxng_extra/index utils/index src/index |