1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
From 2f7cf1c6339719e3a9c0c138d879ad957bb1e626 Mon Sep 17 00:00:00 2001
From: Dominik George <nik@naturalnet.de>
Date: Sat, 29 Apr 2017 17:32:44 +0200
Subject: Strip auto-generation and Sphinx macros from docs.
---
docs/index.rst | 18 +-----------------
1 file changed, 1 insertion(+), 17 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index bae1758..a1af54f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,8 +1,6 @@
flask-mail
======================================
-.. module:: flask-mail
-
One of the most basic functions in a web application is the ability to send
emails to your users.
@@ -14,7 +12,6 @@ Links
* `documentation <http://packages.python.org/Flask-Mail/>`_
* `source <http://github.com/mattupstate/flask-mail>`_
-* :doc:`changelog </changelog>`
Installing Flask-Mail
---------------------
@@ -219,8 +216,6 @@ a message with newlines in the subject, sender or recipient addresses will resul
Signalling support
------------------
-.. versionadded:: 0.4
-
**Flask-Mail** now provides signalling support through a ``email_dispatched`` signal. This is sent whenever an email is
dispatched (even if the email is not actually sent, i.e. in a testing environment).
@@ -236,18 +231,7 @@ app instance as an optional argument::
API
---
-.. module:: flask_mail
-
-.. autoclass:: Mail
- :members: send, connect, send_message
-
-.. autoclass:: Attachment
-
-.. autoclass:: Connection
- :members: send, send_message
-
-.. autoclass:: Message
- :members: attach, add_recipient
+The API documentation can be read using ``pydoc flask_mail``.
.. _Flask: http://flask.pocoo.org
.. _GitHub: http://github.com/mattupstate/flask-mail
|
