Merge branch 'master' into gsoc24

.github/workflows/build.yml

@@ -45,12 +45,15 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+        cache-dependency-path: |
+          **/requirements*.txt
 
     - name: Install Dependencies
       id: deps
       run: |
-        sudo apt update
-        sudo apt-get -qq -y install sqlite3 gdal-bin
+        sudo apt -qq update
+        sudo apt -qq -y install sqlite3 gdal-bin
         pip install -U pip wheel setuptools
         pip install -U -r requirements-test.txt
         pip install -U -e .

README.rst

@@ -1,56 +1,55 @@
-======================
 OpenWISP Notifications
 ======================
 
 .. image:: https://github.com/openwisp/openwisp-notifications/workflows/OpenWISP%20CI%20Build/badge.svg?branch=master
-   :target: https://github.com/openwisp/openwisp-notifications/actions?query=workflow%3A%22OpenWISP+CI+Build%22
-   :alt: CI build status
+    :target: https://github.com/openwisp/openwisp-notifications/actions?query=workflow%3A%22OpenWISP+CI+Build%22
+    :alt: CI build status
 
 .. image:: https://coveralls.io/repos/github/openwisp/openwisp-notifications/badge.svg?branch=master
-   :target: https://coveralls.io/github/openwisp/openwisp-notifications?branch=master
-   :alt: Test Coverage
+    :target: https://coveralls.io/github/openwisp/openwisp-notifications?branch=master
+    :alt: Test Coverage
 
 .. image:: https://img.shields.io/librariesio/github/openwisp/openwisp-notifications
-   :target: https://libraries.io/github/openwisp/openwisp-notifications#repository_dependencies
-   :alt: Dependency monitoring
+    :target: https://libraries.io/github/openwisp/openwisp-notifications#repository_dependencies
+    :alt: Dependency monitoring
 
 .. image:: https://img.shields.io/gitter/room/nwjs/nw.js.svg
-   :target: https://gitter.im/openwisp/general
-   :alt: chat
+    :target: https://gitter.im/openwisp/general
+    :alt: chat
 
 .. image:: https://badge.fury.io/py/openwisp-notifications.svg
-   :target: http://badge.fury.io/py/openwisp-notifications
-   :alt: Pypi Version
+    :target: http://badge.fury.io/py/openwisp-notifications
+    :alt: Pypi Version
 
 .. image:: https://pepy.tech/badge/openwisp-notifications
-   :target: https://pepy.tech/project/openwisp-notifications
-   :alt: downloads
+    :target: https://pepy.tech/project/openwisp-notifications
+    :alt: downloads
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-   :target: https://pypi.org/project/black/
-   :alt: code style: black
+    :target: https://pypi.org/project/black/
+    :alt: code style: black
 
-------------
+----
 
 .. figure:: https://github.com/openwisp/openwisp-notifications/raw/docs/docs/images/notification-demo.gif
-   :align: center
+    :align: center
 
 **OpenWISP Notifications** provides email and web notifications for
 `OpenWISP <http://openwisp.org>`_.
 
 Its main goal is to allow the other OpenWISP modules to notify users about
 meaningful events that happen in their network.
 
-**For a more complete overview of the OpenWISP modules and architecture**,
-see the
-`OpenWISP Architecture Overview
-<https://openwisp.io/docs/general/architecture.html>`_.
+For a complete overview of features, refer to the `Notifications: Features
+<https://openwisp.io/docs/dev/notifications/user/intro.html>`_ section of
+the OpenWISP documentation.
 
-------------
+Documentation
+-------------
 
-.. contents:: **Table of Contents**:
-   :backlinks: none
-   :depth: 3
+- `Usage documentation <https://openwisp.io/docs/dev/notifications/>`_
+- `Developer documentation
+  <https://openwisp.io/docs/dev/notifications/developer/>`_
 
 ------------
 
@@ -1570,12 +1569,14 @@ For more information regarding Channels' Consumers, please refer to the
 Contributing
 ------------
 
-Please read the `OpenWISP contributing guidelines <http://openwisp.io/docs/developer/contributing.html>`_.
+Please read the `OpenWISP contributing guidelines
+<http://openwisp.io/docs/developer/contributing.html>`_.
 
 License
 -------
 
-See `LICENSE <https://github.com/openwisp/openwisp-notifications/blob/master/LICENSE>`_.
+See `LICENSE
+<https://github.com/openwisp/openwisp-notifications/blob/master/LICENSE>`_.
 
 Support
 -------
@@ -1588,15 +1589,18 @@ Attributions
 Icons
 ~~~~~
 
-`Icons <https://github.com/openwisp/openwisp-notifications/tree/master/openwisp_notifications/static/openwisp-notifications/images/icons/>`_
+`Icons
+<https://github.com/openwisp/openwisp-notifications/tree/master/openwisp_notifications/static/openwisp-notifications/images/icons/>`_
 used are taken from `Font Awesome <https://fontawesome.com/>`_ project.
 
-LICENSE: `https://fontawesome.com/license <https://fontawesome.com/license>`_
+LICENSE: https://fontawesome.com/license
 
 Sound
 ~~~~~
 
-`Notification sound <https://github.com/openwisp/openwisp-notifications/tree/master/openwisp_notifications/static/openwisp-notifications/audio>`_
+`Notification sound
+<https://github.com/openwisp/openwisp-notifications/tree/master/openwisp_notifications/static/openwisp-notifications/audio>`_
 is taken from `Notification Sounds <https://notificationsounds.com/>`_.
 
-LICENSE: `Creative Commons Attribution license <https://creativecommons.org/licenses/by/4.0/legalcode>`_
+LICENSE: `Creative Commons Attribution license
+<https://creativecommons.org/licenses/by/4.0/legalcode>`_