From 870bf312d8956922e59f1fd3798a7014dd4550a3 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Thu, 23 Dec 2021 10:59:44 +0100 Subject: [PATCH] [doc] switch from sphinx-tabs extension to sphinx-design A sphinx extension for designing beautiful, view size responsive web components [2]. Supports fure theme [3]. [1] https://github.com/djungelorm/sphinx-tabs [2] https://github.com/executablebooks/sphinx-design [3] https://sphinx-design.readthedocs.io/en/furo-theme/ Signed-off-by: Markus Heiser --- docs/admin/buildhosts.rst | 24 ++++----- docs/admin/installation-apache.rst | 54 ++++++++++---------- docs/admin/installation-nginx.rst | 40 +++++++-------- docs/admin/installation-searxng.rst | 6 +-- docs/admin/installation-uwsgi.rst | 24 +++------ docs/build-templates/filtron.rst | 12 ++--- docs/build-templates/morty.rst | 12 ++--- docs/build-templates/searx.rst | 52 ++++++++++---------- docs/conf.py | 2 +- docs/dev/lxcdev.rst | 76 ++++++++++++++--------------- requirements-dev.txt | 1 + utils/filtron.sh | 4 +- utils/morty.sh | 4 +- 13 files changed, 152 insertions(+), 159 deletions(-) diff --git a/docs/admin/buildhosts.rst b/docs/admin/buildhosts.rst index e23327ba8..85e0873c3 100644 --- a/docs/admin/buildhosts.rst +++ b/docs/admin/buildhosts.rst @@ -75,21 +75,21 @@ If your docs build (``make docs.html``) shows warnings like this:: you need to install additional packages on your build host, to get better HTML output. -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code-block:: sh $ sudo apt install graphviz imagemagick texlive-xetex librsvg2-bin - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code-block:: sh $ sudo pacman -S graphviz imagemagick texlive-bin extra/librsvg - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code-block:: sh @@ -98,21 +98,21 @@ output. For PDF output you also need: -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: sh $ sudo apt texlive-latex-recommended texlive-extra-utils ttf-dejavu - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code:: sh $ sudo pacman -S texlive-core texlive-latexextra ttf-dejavu - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code:: sh @@ -132,21 +132,21 @@ To lint shell scripts, we use ShellCheck_ - A shell script static analysis tool. .. SNIP sh lint requirements -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code-block:: sh $ sudo apt install shellcheck - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code-block:: sh $ sudo pacman -S shellcheck - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code-block:: sh diff --git a/docs/admin/installation-apache.rst b/docs/admin/installation-apache.rst index b60e20ad1..d8893868c 100644 --- a/docs/admin/installation-apache.rst +++ b/docs/admin/installation-apache.rst @@ -69,15 +69,15 @@ If Apache_ is not installed, install it now. If apache_ is new to you, the Directives`_ documentation gives first orientation. There is also a list of `Apache directives`_ *to keep in the pocket*. -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: sh sudo -H apt-get install apache2 - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code:: sh @@ -85,7 +85,7 @@ Directives`_ documentation gives first orientation. There is also a list of sudo -H systemctl enable httpd sudo -H systemctl start http - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code:: sh @@ -97,9 +97,9 @@ Now at http://localhost you should see any kind of *Welcome* or *Test* page. How this default intro site is configured, depends on the linux distribution (compare `Apache directives`_). -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: sh @@ -113,7 +113,7 @@ How this default intro site is configured, depends on the linux distribution And the *welcome* page is the HTML file at ``/var/www/html/index.html``. - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code:: sh @@ -140,7 +140,7 @@ How this default intro site is configured, depends on the linux distribution ... Include conf/extra/httpd-autoindex.conf - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code:: sh @@ -180,9 +180,9 @@ modules and create a `Location`_ configuration for the SearXNG site. In most distributions you have to un-comment the lines in the main configuration file, except in :ref:`The Debian Layout`. -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian In the Apache setup, enable headers and proxy modules: @@ -201,7 +201,7 @@ except in :ref:`The Debian Layout`. sudo -H a2ensite searxng.conf - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux In the ``/etc/httpd/conf/httpd.conf`` file, activate headers and proxy modules (LoadModule_): @@ -214,7 +214,7 @@ except in :ref:`The Debian Layout`. LoadModule proxy_module modules/mod_proxy.so LoadModule proxy_http_module modules/mod_proxy_http.so - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL In the ``/etc/httpd/conf/httpd.conf`` file, activate headers and proxy modules (LoadModule_): @@ -232,9 +232,9 @@ proxied host. .. _apache searxng via filtron plus morty: -.. tabs:: +.. tab-set:: - .. group-tab:: SearXNG via filtron plus morty + .. tab-item:: SearXNG via filtron plus morty Use this setup, if your instance is public to the internet, compare figure: :ref:`architecture ` and :ref:`installation scripts`. @@ -307,9 +307,9 @@ filtron>`, nevertheless it is good enough for intranet usage. In modern Linux distributions, the `mod_proxy_uwsgi`_ is compiled into the *normal* apache package and you need to install only the :ref:`uWSGI ` package: -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: sh @@ -318,13 +318,13 @@ package and you need to install only the :ref:`uWSGI ` package: # Ubuntu =< 18.04 sudo -H apt-get install libapache2-mod-proxy-uwsgi - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code:: sh sudo -H pacman -S uwsgi - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code:: sh @@ -347,9 +347,9 @@ SearXNG account (see :ref:`create searxng user`): If the server is public; to limit access to your intranet replace ``Allow from all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class. -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: apache @@ -373,7 +373,7 @@ all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class. - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code:: apache @@ -398,7 +398,7 @@ all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class. - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code:: apache @@ -426,7 +426,7 @@ all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class. - .. group-tab:: old mod_wsgi + .. tab-item:: old mod_wsgi We show this only for historical reasons, DON'T USE `mod_uwsgi `_. @@ -461,23 +461,23 @@ all`` directive and replace ``192.168.0.0/16`` with your subnet IP/class. Restart service =============== -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: sh sudo -H systemctl restart apache2 sudo -H service uwsgi restart searx - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code:: sh sudo -H systemctl restart httpd sudo -H systemctl restart uwsgi@searx - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code:: sh diff --git a/docs/admin/installation-nginx.rst b/docs/admin/installation-nginx.rst index fdbcdf032..5d507957e 100644 --- a/docs/admin/installation-nginx.rst +++ b/docs/admin/installation-nginx.rst @@ -55,15 +55,15 @@ The nginx HTTP server If nginx_ is not installed (uwsgi will not work with the package nginx-light), install it now. -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: sh sudo -H apt-get install nginx - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code-block:: sh @@ -71,7 +71,7 @@ install it now. sudo -H systemctl enable nginx sudo -H systemctl start nginx - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code-block:: sh @@ -84,9 +84,9 @@ see a *Fedora Webserver - Test Page*. The test page comes from the default `nginx server configuration`_. How this default intro site is configured, depends on the linux distribution: -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: sh @@ -98,7 +98,7 @@ depends on the linux distribution: include /etc/nginx/sites-enabled/*; - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code-block:: sh @@ -114,7 +114,7 @@ depends on the linux distribution: # ... } - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code-block:: sh @@ -142,9 +142,9 @@ Now you have to create a configuration for the SearXNG site. If nginx_ is new t you, the `nginx beginners guide`_ is a good starting point and the `Getting Started wiki`_ is always a good resource *to keep in the pocket*. -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian Create configuration at ``/etc/nginx/sites-available/searxng`` and place a symlink to sites-enabled: @@ -153,21 +153,21 @@ Started wiki`_ is always a good resource *to keep in the pocket*. sudo -H ln -s /etc/nginx/sites-available/searxng /etc/nginx/sites-enabled/searxng - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux In the ``/etc/nginx/nginx.conf`` file, replace the configuration section named ``server``. - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL Create configuration at ``/etc/nginx/conf.d/searxng`` and place a symlink to sites-enabled: .. _nginx searxng via filtron plus morty: -.. tabs:: +.. tab-set:: - .. group-tab:: SearXNG via filtron plus morty + .. tab-item:: SearXNG via filtron plus morty Use this setup, if your instance is public to the internet, compare figure: :ref:`architecture ` and :ref:`installation scripts`. @@ -226,7 +226,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*. image_proxy : True - .. group-tab:: proxy or uWSGI + .. tab-item:: proxy or uWSGI Be warned, with this setup, your instance isn't :ref:`protected `. Nevertheless it is good enough for intranet usage and it is a @@ -288,7 +288,7 @@ Started wiki`_ is always a good resource *to keep in the pocket*. mkdir -p /run/uwsgi/app/searx/ sudo -H chown -R searx:searx /run/uwsgi/app/searx/ - .. group-tab:: \.\. at subdir URL + .. tab-item:: \.\. at subdir URL Be warned, with these setups, your instance isn't :ref:`protected `. The examples are just here to demonstrate how to export the @@ -344,23 +344,23 @@ Started wiki`_ is always a good resource *to keep in the pocket*. Restart service: -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code:: sh sudo -H systemctl restart nginx sudo -H service uwsgi restart searx - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code:: sh sudo -H systemctl restart nginx sudo -H systemctl restart uwsgi@searx - .. group-tab:: Fedora + .. tab-item:: Fedora .. code:: sh diff --git a/docs/admin/installation-searxng.rst b/docs/admin/installation-searxng.rst index b14139310..b531a2858 100644 --- a/docs/admin/installation-searxng.rst +++ b/docs/admin/installation-searxng.rst @@ -90,14 +90,14 @@ For a *minimal setup*, configure like shown below – replace ``searx@$(uname :start-after: START searxng config :end-before: END searxng config -.. tabs:: +.. tab-set:: - .. group-tab:: Use default settings + .. tab-item:: Use default settings .. literalinclude:: ../../utils/templates/etc/searxng/settings.yml :language: yaml - .. group-tab:: searx/settings.yml + .. tab-item:: searx/settings.yml .. literalinclude:: ../../searx/settings.yml :language: yaml diff --git a/docs/admin/installation-uwsgi.rst b/docs/admin/installation-uwsgi.rst index 1021283f9..c862e3e2b 100644 --- a/docs/admin/installation-uwsgi.rst +++ b/docs/admin/installation-uwsgi.rst @@ -100,50 +100,42 @@ Alltogether Create the configuration ini-file according to your distribution (see below) and restart the uwsgi application. -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START searxng uwsgi-description ubuntu-20.04 :end-before: END searxng uwsgi-description ubuntu-20.04 - .. hotfix: a bug group-tab need this comment - - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START searxng uwsgi-description arch :end-before: END searxng uwsgi-description arch - .. hotfix: a bug group-tab need this comment - - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START searxng uwsgi-description fedora :end-before: END searxng uwsgi-description fedora -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START searxng uwsgi-appini ubuntu-20.04 :end-before: END searxng uwsgi-appini ubuntu-20.04 - .. hotfix: a bug group-tab need this comment - - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START searxng uwsgi-appini arch :end-before: END searxng uwsgi-appini arch - .. hotfix: a bug group-tab need this comment - - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. kernel-include:: $DOCS_BUILD/includes/searx.rst :start-after: START searxng uwsgi-appini fedora diff --git a/docs/build-templates/filtron.rst b/docs/build-templates/filtron.rst index a858f7ddd..42502b0fd 100644 --- a/docs/build-templates/filtron.rst +++ b/docs/build-templates/filtron.rst @@ -1,8 +1,8 @@ .. START create user -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: sh @@ -17,9 +17,9 @@ .. START install go -.. tabs:: +.. tab-set:: - .. group-tab:: os: linux / arch: amd64 + .. tab-item:: os: linux / arch: amd64 .. code-block:: bash @@ -41,9 +41,9 @@ .. START install filtron -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: bash diff --git a/docs/build-templates/morty.rst b/docs/build-templates/morty.rst index b03a54f96..6f6c2a9c0 100644 --- a/docs/build-templates/morty.rst +++ b/docs/build-templates/morty.rst @@ -1,8 +1,8 @@ .. START create user -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: sh @@ -17,9 +17,9 @@ .. START install go -.. tabs:: +.. tab-set:: - .. group-tab:: os: linux / arch: amd64 + .. tab-item:: os: linux / arch: amd64 .. code-block:: bash @@ -41,9 +41,9 @@ .. START install morty -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: bash diff --git a/docs/build-templates/searx.rst b/docs/build-templates/searx.rst index 626cce6bd..14ee1bc92 100644 --- a/docs/build-templates/searx.rst +++ b/docs/build-templates/searx.rst @@ -3,23 +3,23 @@ .. START distro-packages -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code-block:: sh $ sudo -H apt-get install -y \\ ${debian} - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code-block:: sh $ sudo -H pacman -S --noconfirm \\ ${arch} - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code-block:: sh @@ -30,23 +30,23 @@ ${fedora} .. START build-packages -.. tabs:: +.. tab-set:: - .. group-tab:: Ubuntu / debian + .. tab-item:: Ubuntu / debian .. code-block:: sh $ sudo -H apt-get install -y \\ ${debian_build} - .. group-tab:: Arch Linux + .. tab-item:: Arch Linux .. code-block:: sh $ sudo -H pacman -S --noconfirm \\ ${arch_build} - .. group-tab:: Fedora / RHEL + .. tab-item:: Fedora / RHEL .. code-block:: sh @@ -57,9 +57,9 @@ ${fedora_build} .. START create user -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: sh @@ -74,9 +74,9 @@ ${fedora_build} .. START clone searxng -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: sh @@ -87,9 +87,9 @@ ${fedora_build} .. START create virtualenv -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: sh @@ -100,9 +100,9 @@ ${fedora_build} .. START manage.sh update_packages -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: sh @@ -127,9 +127,9 @@ ${fedora_build} .. START searxng config -.. tabs:: +.. tab-set:: - .. group-tab:: Use default settings + .. tab-item:: Use default settings .. code-block:: sh @@ -137,7 +137,7 @@ ${fedora_build} $ sudo -H cp \"$SEARX_SRC/utils/templates/etc/searxng/settings.yml\" \\ \"${SEARXNG_SETTINGS_PATH}\" - .. group-tab:: searx/settings.yml + .. tab-item:: searx/settings.yml .. code-block:: sh @@ -145,9 +145,9 @@ ${fedora_build} $ sudo -H cp \"$SEARX_SRC/searx/settings.yml\" \\ \"${SEARXNG_SETTINGS_PATH}\" -.. tabs:: +.. tab-set:: - .. group-tab:: minimal setup + .. tab-item:: minimal setup .. code-block:: sh @@ -157,9 +157,9 @@ ${fedora_build} .. START check searxng installation -.. tabs:: +.. tab-set:: - .. group-tab:: bash + .. tab-item:: bash .. code-block:: sh @@ -178,15 +178,15 @@ ${fedora_build} Open WEB browser and visit http://$SEARX_INTERNAL_HTTP . If you are inside a container or in a script, test with curl: -.. tabs:: +.. tab-set:: - .. group-tab:: WEB browser + .. tab-item:: WEB browser .. code-block:: sh $ xdg-open http://$SEARX_INTERNAL_HTTP - .. group-tab:: curl + .. tab-item:: curl .. code-block:: none diff --git a/docs/conf.py b/docs/conf.py index 6288c5a0e..ff4816b94 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -113,7 +113,7 @@ extensions = [ 'linuxdoc.kernel_include', # Implementation of the 'kernel-include' reST-directive. 'linuxdoc.rstFlatTable', # Implementation of the 'flat-table' reST-directive. 'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling. - "sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs + 'sphinx_design', # https://github.com/executablebooks/sphinx-design ] intersphinx_mapping = { diff --git a/docs/dev/lxcdev.rst b/docs/dev/lxcdev.rst index 597f99925..7db95c1c4 100644 --- a/docs/dev/lxcdev.rst +++ b/docs/dev/lxcdev.rst @@ -69,9 +69,9 @@ Gentlemen, start your engines! Before you can start with containers, you need to install and initiate LXD_ once: -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -81,9 +81,9 @@ once: And you need to clone from origin or if you have your own fork, clone from your fork: -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -97,9 +97,9 @@ we exercise on a archlinux_ image. The container of this image is named ``searx-archlinux``. Lets build the container, but be sure that this container does not already exists, so first lets remove possible old one: -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -113,9 +113,9 @@ does not already exists, so first lets remove possible old one: In this container we install all services :ref:`including searx, morty & filtron ` in once: -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -124,9 +124,9 @@ In this container we install all services :ref:`including searx, morty & filtron To proxy HTTP from filtron and morty in the container to the outside of the container, install nginx into the container. Once for the bot blocker filtron: -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -137,9 +137,9 @@ container, install nginx into the container. Once for the bot blocker filtron: and once for the content sanitizer (content proxy morty): -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -171,9 +171,9 @@ Usually you open a root-bash using ``sudo -H bash``. In case of LXC containers open the root-bash in the container using ``./utils/lxc.sh cmd searx-archlinux``: -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -185,9 +185,9 @@ searx-archlinux``: The prompt ``[root@searx-archlinux ...]`` signals, that you are the root user in the searx-container. To debug the running SearXNG instance use: -.. tabs:: +.. tab-set:: - .. group-tab:: root@searx-archlinux + .. tab-item:: root@searx-archlinux .. code:: sh @@ -202,9 +202,9 @@ above. You can stop monitoring using ``CTRL-C``, this also disables the *"debug option"* in SearXNG's settings file and restarts the SearXNG uwsgi application. To debug services from filtron and morty analogous use: -.. tabs:: +.. tab-set:: - .. group-tab:: root@searx-archlinux + .. tab-item:: root@searx-archlinux .. code:: sh @@ -216,9 +216,9 @@ Another point we have to notice is that each service (:ref:`SearXNG `, system user account with the same name (compare :ref:`create searxng user`). To get a shell from theses accounts, simply call one of the scripts: -.. tabs:: +.. tab-set:: - .. group-tab:: root@searx-archlinux + .. tab-item:: root@searx-archlinux .. code:: sh @@ -228,9 +228,9 @@ get a shell from theses accounts, simply call one of the scripts: To get in touch, open a shell from the service user (searx@searx-archlinux): -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -243,9 +243,9 @@ The prompt ``[searx@searx-archlinux]`` signals that you are logged in as system user ``searx`` in the ``searx-archlinux`` container and the python *virtualenv* ``(searx-pyenv)`` environment is activated. -.. tabs:: +.. tab-set:: - .. group-tab:: searx@searx-archlinux + .. tab-item:: searx@searx-archlinux .. code:: sh @@ -271,9 +271,9 @@ With the use of the :ref:`searx.sh` the SearXNG service was installed as ``systemctl`` (compare :ref:`service architectures on distributions `). -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -303,9 +303,9 @@ the **transparent** reposetory from the desktop. Now lets replace the repository at ``searx-src`` in the container with the working tree from outside of the container: -.. tabs:: +.. tab-set:: - .. group-tab:: container becomes a developer suite + .. tab-item:: container becomes a developer suite .. code:: sh @@ -319,9 +319,9 @@ Now we can develop as usual in the working tree of our desktop system. Every time the software was changed, you have to restart the SearXNG service (in the conatiner): -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh @@ -332,9 +332,9 @@ conatiner): Remember: :ref:`working in containers` .. here are just some examples from my daily usage: -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop To *inspect* the SearXNG instance (already described above): @@ -378,9 +378,9 @@ We build up a fully functional SearXNG suite in a archlinux container: To access HTTP from the desktop we installed nginx for the services inside the conatiner: -.. tabs:: +.. tab-set:: - .. group-tab:: [root@searx-archlinux] + .. tab-item:: [root@searx-archlinux] .. code:: sh @@ -391,9 +391,9 @@ To wrap the suite into a developer one, we created a symbolic link to the repository which is shared **transparent** from the desktop's file system into the container : -.. tabs:: +.. tab-set:: - .. group-tab:: [root@searx-archlinux] + .. tab-item:: [root@searx-archlinux] .. code:: sh @@ -404,9 +404,9 @@ the container : To get information about the searxNG suite in the archlinux container we can use: -.. tabs:: +.. tab-set:: - .. group-tab:: desktop + .. tab-item:: desktop .. code:: sh diff --git a/requirements-dev.txt b/requirements-dev.txt index 8cab08fb0..66184e4a9 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -7,6 +7,7 @@ splinter==0.16.0 selenium==3.141.0 twine==3.7.1 furo==2021.11.23 +sphinx-design==0.0.13 Sphinx==4.3.1 sphinx-issues==1.2.0 sphinx-jinja==1.2.1 diff --git a/utils/filtron.sh b/utils/filtron.sh index 2536214e4..171557e6a 100755 --- a/utils/filtron.sh +++ b/utils/filtron.sh @@ -604,9 +604,9 @@ rst-doc() { echo -e "\n.. START install systemd unit" cat <