fixed doc errors

liiight · Jul 13, 2022 · f3418df · f3418df
1 parent ae59588
commit f3418df
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 276 deletions.
diff --git a/source/CLI.rst b/source/CLI.rst
@@ -41,7 +41,7 @@ To view all providers use the ``providers`` command like so:
 .. code-block:: console
 
      $ notifiers providers
-     pushover, simplepush, slack, email, gmail, telegram, gitter, pushbullet, join, hipchat, zulip, victorops
+     pushover, simplepush, slack, email, gmail, telegram, gitter, pushbullet, join, zulip, victorops
 
 This will return all available provider names
 

diff --git a/source/api/providers.rst b/source/api/providers.rst
@@ -18,10 +18,6 @@ API documentation for the different providers.
    :members:
    :undoc-members:
 
-.. automodule:: notifiers.providers.hipchat
-   :members:
-   :undoc-members:
-
 .. automodule:: notifiers.providers.join
    :members:
    :undoc-members:

diff --git a/source/providers/hipchat.rst b/source/providers/hipchat.rst
diff --git a/source/providers/icloud.rst b/source/providers/icloud.rst
@@ -15,12 +15,13 @@ This is a private use case of the :class:`~notifiers.providers.email.SMTP` provi
 
 
 .. code-block:: yaml
+
     required:
     - username
     - password
     - from_
     - to
     type: object
 
-from_ can be an iCloud alias
+``from_`` can be an iCloud alias
 username must be your primary iCloud username
diff --git a/source/providers/index.rst b/source/providers/index.rst
@@ -9,7 +9,6 @@ Providers
    email
    gitter
    gmail
-   hipchat
    join
    mailgun
    pagerduty
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,7 +9,6 @@ Providers @@
        email
        gitter
        gmail
-       hipchat
        join
        mailgun
        pagerduty
@@ Expand Down @@