diff --git a/README.md b/README.md index f55e45e..13cbbf4 100644 --- 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 index 7d00866..384a5fb 100644 --- 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 `_ for best practices. @@ -29,7 +30,7 @@ Installation ============ Install the stable version of notif: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: sh @@ -37,7 +38,7 @@ Install the stable version of notif: Install the latest version of notif: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: sh diff --git a/docs/source/notificator.rst b/docs/source/notificator.rst index a555ce6..b696fae 100644 --- 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 \ No newline at end of file +--------------------------- +.. autoclass:: TeamsNotificator + +Discord Notificator +------------------- +.. autoclass:: DiscordNotificator \ No newline at end of file