mirror of
https://github.com/searxng/searxng
synced 2024-01-01 19:24:07 +01:00
[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 <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser
parent
139554989c
commit
870bf312d8
13 changed files with 152 additions and 159 deletions
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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 <arch public>` 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 <searxng 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 <searxng 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.
|
|||
|
||||
</Location>
|
||||
|
||||
.. 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.
|
|||
|
||||
</Location>
|
||||
|
||||
.. 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.
|
|||
|
||||
</IfModule>
|
||||
|
||||
.. group-tab:: old mod_wsgi
|
||||
.. tab-item:: old mod_wsgi
|
||||
|
||||
We show this only for historical reasons, DON'T USE `mod_uwsgi
|
||||
<https://uwsgi-docs.readthedocs.io/en/latest/Apache.html#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
|
||||
|
||||
|
|
|
|||
|
|
@ -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 <arch public>` 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 <searxng
|
||||
filtron>`. 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 <searxng
|
||||
filtron>`. 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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue