added doc

davebulaval · Oct 1, 2021 · 75209f8 · 75209f8
1 parent 3c79a34
commit 75209f8
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -10,10 +10,11 @@ Notif is a easy to use package to send notification from a python script.
 
 Use this package to send during, at the end or when failing of a python script a
 
-    - Slack notification
-    - Email notification
-    - Channel notification
-    - Microsoft Teams notification.
+    - Slack notification,
+    - Email notification,
+    - Channel notification,
+    - Microsoft Teams notification,
+    - Discord.
 
 > Please be careful with your login credential. Use a .env or any other file not publish by your git (configured in .gitignore). Read the [following](https://stackoverflow.com/questions/2397822/what-is-the-best-practice-for-dealing-with-passwords-in-git-repositories) for best pratices.
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,10 +17,11 @@ Notif is a easy to use package to send notification from a python script.
 
 Use this package to send during, at the end or when failing of a python script a
 
-    - Slack notification
-    - Email notification
-    - Channel notification
-    - Microsoft Teams notification.
+    - Slack notification,
+    - Email notification,
+    - Channel notification,
+    - Microsoft Teams notification,
+    - Discord.
 
 
 .. warning:: Please be careful with your login credential. Use a .env or any other file not publish by your git (configured in .gitignore). Read the `following <https://stackoverflow.com/questions/2397822/what-is-the-best-practice-for-dealing-with-passwords-in-git-repositories/>`_ for best practices.
@@ -29,15 +30,15 @@ Installation
 ============
 
 Install the stable version of notif:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: sh
 
    pip install notif
 
 
 Install the latest version of notif:
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: sh
 

diff --git a/docs/source/notificator.rst b/docs/source/notificator.rst
@@ -2,32 +2,36 @@
     :class: hidden-section
 
 Notificator
-===========================
+===========
 
 .. automodule:: notif
 .. currentmodule:: notif.notificator
 
 Notificator
----------------
+-----------
 .. autoclass:: Notificator
     :members:
 
 Slack Notificator
----------------------
+-----------------
 
 .. autoclass:: SlackNotificator
     :members:
 
 Email Notificator
---------------------
+-----------------
 
 .. autoclass:: EmailNotificator
 
 Channel Notificator
-----------------------
+-------------------
 
 .. autoclass:: ChannelNotificator
 
 Microsoft Teams Notificator
----------------------------------
-.. autoclass:: TeamsNotificator
+---------------------------
+.. autoclass:: TeamsNotificator
+
+Discord Notificator
+-------------------
+.. autoclass:: DiscordNotificator