Skip to content

Commit

Permalink
docs: format improved 📝
Browse files Browse the repository at this point in the history
  • Loading branch information
inforian committed Jun 7, 2017
1 parent 3d655e8 commit b1179db
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
19 changes: 12 additions & 7 deletions docs/source/email.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@ Email Providers
notification_type = 'email'
- General Settings you need to configure in Django Project when using any email providers are mentioned below :

- Some settings can be passed as function arguments as well as in `Django settings`. The main AIM is to provide all
possible flexibility to user to use Any `Provider` with any configuration.
possible flexibility to user to use Any `Provider` with any configuration.

- If we Add settings in `Django settings` then in entire project those settings will be used But if you want every
notification use different provider configuration then that is also possible here.
notification use different provider configuration then that is also possible here.


> General Settings
------------------
Expand Down Expand Up @@ -56,12 +59,14 @@ Default email address to use for various outgoing emails.
provider = 'gmail'
- You can use Gmail as your **SMTP** provider an send Emails from Your own Gmail account.
- You can use Gmail as your **SMTP** provider an send Emails from Your own `Gmail` account.

- For this you need below settings to configure in your Django Project.

- Sample settings for Gmail Provider are as follows:

As Django settings :
~~~~~~~~~~~~~~~~~~~~
++++++++++++++++++++

.. code-block:: python
Expand All @@ -74,7 +79,7 @@ As Django settings :
DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
As Function Arguments:
~~~~~~~~~~~~~~~~~~~~~~
++++++++++++++++++++++

- `EMAIL_HOST_USER` as `username`.
- `EMAIL_HOST_PASSWORD` as `password`.
Expand Down Expand Up @@ -128,7 +133,7 @@ SENDGRID_API_KEY :
- Sample settings for SendGrid Provider are as follows:

As Django settings :
~~~~~~~~~~~~~~~~~~~~
++++++++++++++++++++

.. code-block:: python
Expand All @@ -141,7 +146,7 @@ As Django settings :
DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
As Function Arguments:
~~~~~~~~~~~~~~~~~~~~~~
++++++++++++++++++++++

- `SENDGRID_API_KEY` as `sendgrid_api_key`.

Expand Down
7 changes: 5 additions & 2 deletions docs/source/sms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@ SMS Providers
notification_type = 'sms'
- General Settings you need to configure in Django Project when using any email providers are mentioned below :

- Some settings can be passed as function arguments as well as in `Django settings`. The main AIM is to provide all
possible flexibility to user to use Any `Provider` with any configuration.
possible flexibility to user to use Any `Provider` with any configuration.

- If we Add settings in `Django settings` then in entire project those settings will be used But if you want every
notification use different provider configuration then that is also possible here.
notification use different provider configuration then that is also possible here.


> Plivo
-------
Expand Down

0 comments on commit b1179db

Please sign in to comment.