Skip to content

Commit 6833dca

Browse files
authored
Fix docs build (#82)
Update supported providers
1 parent f5aeca5 commit 6833dca

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

docs/conf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,14 @@
2020
import os
2121
import sys
2222

23-
import django
23+
from django.conf import settings
2424

2525
project = 'django-notifs'
2626
copyright = '2021, Daniel Osaetin'
2727
author = 'Daniel Osaetin'
2828

2929
sys.path.append(os.path.abspath('../../'))
30-
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notifs.settings')
31-
django.setup()
30+
settings.configure()
3231

3332

3433
# -- General configuration ---------------------------------------------------

docs/overview.rst

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,17 @@ Requirements
1010
Supported Functionality
1111
-----------------------
1212

13-
- In-app notifications
14-
- Silent notifications (i.e Notifications that aren't saved in the database)
15-
- Custom delivery (notification) channels e.g Telegram, Slack, SMS etc
16-
- Asynchronous notifications (with support for multiple backends e.g Celery, RQ, AwsLambda etc)
13+
* In-app notifications
14+
* Silent notifications (i.e Notifications that aren't saved in the database)
15+
* Delivery providers e.g Email, Slack, SMS etc
16+
* Custom delivery channels and providers
17+
* Asynchronous notifications (with support for multiple backends e.g Celery, RQ, AwsLambda etc)
18+
19+
Supported providers
20+
-------------------
21+
* :ref:`Email <Email>`: SMTP and Transaction email providers (Amazon SES, Mailgun, Mailjet, Postmark, SendinBlue, SendGrid, SparkPost and Mandrill) with `django-anymail <https://anymail.readthedocs.io/>`_
22+
* :ref:`SMS <SMS (with django-sms)>`: (Twilio, Messagebird) with `django-sms <https://django-sms.readthedocs.io/en/latest/>`_
23+
* :ref:`Slack <Slack>`
24+
* :ref:`Pusher Channels <Pusher Channels>`
25+
* :ref:`FCM - Web push notifications (*deprecated*) <FCM (Firebase Web push)>`
26+
* :ref:`Django channels <django-channels>`

0 commit comments

Comments
 (0)