Browse Source

Merge pull request #29 from Miksus/docs/add_flask_redmail

DOCS: add flask-redmail
Mikael Koli 4 years ago
parent
commit
ed51f87656
4 changed files with 21 additions and 3 deletions
  1. 15 0
      docs/extensions/flask.rst
  2. 3 2
      docs/extensions/index.rst
  3. 1 1
      docs/extensions/logging.rst
  4. 2 0
      docs/index.rst

+ 15 - 0
docs/extensions/flask.rst

@@ -0,0 +1,15 @@
+.. _ext-flask:
+
+Flask Extension
+===============
+
+For Flask web applications, you may use the Flask extension: 
+**Flask-Redmail**. Even though it is trivial to use Red Mail
+in such applications, Flask-Redmail integrates with Flask's
+configurations to make it slightly easier to manage.
+
+Read more:
+
+- `flask-redmail's documentation <https://flask-redmail.readthedocs.io/>`_
+- `flask-redmail's source code <https://github.com/Miksus/flask-redmail>`_
+- `flask-redmail's releases from PyPI <https://pypi.org/project/Flask-Redmail/>`_

+ 3 - 2
docs/extensions/index.rst

@@ -4,10 +4,11 @@ Extensions
 
 This section covers Red Mail's extensions. Extensions are 
 tools that helps to integrate the email sender to other 
-tasks such as logging.
+purposes such as logging or web applications.
 
 .. toctree::
    :maxdepth: 1
    :caption: Contents:
 
-   logging.rst
+   logging.rst
+   flask.rst

+ 1 - 1
docs/extensions/logging.rst

@@ -1,4 +1,4 @@
-
+.. _ext-logging:
 
 Email Logging
 =============

+ 2 - 0
docs/index.rst

@@ -80,6 +80,8 @@ There are also other reasons to use Red Mail:
 - :ref:`Gmail <config-gmail>` and :ref:`Outlook <config-outlook>` pre-configured
 - :ref:`Send with cc and bcc <send-cc-bcc>`
 - :ref:`Change the email protocol to what you need <config-smtp>`
+- :ref:`Easy to use logging handler <ext-logging>`
+- :ref:`Easy to use Flask extension <ext-flask>`
 - And it is well tested and documented