Add flask_security.utils documentation for selected functions. Addressed #169

This commit is contained in:
Matt Wright
2013-12-19 12:57:11 -05:00
parent be9af2e107
commit 615bc00c26
2 changed files with 57 additions and 1 deletions
+22
View File
@@ -54,6 +54,28 @@ Datastores
:inherited-members:
Utils
-----
.. autofunction:: flask_security.utils.login_user
.. autofunction:: flask_security.utils.logout_user
.. autofunction:: flask_security.utils.get_hmac
.. autofunction:: flask_security.utils.verify_password
.. autofunction:: flask_security.utils.verify_and_update_password
.. autofunction:: flask_security.utils.encrypt_password
.. autofunction:: flask_security.utils.url_for_security
.. autofunction:: flask_security.utils.get_within_delta
.. autofunction:: flask_security.utils.send_mail
.. autofunction:: flask_security.utils.get_token_status
Signals
-------
See the `Flask documentation on signals`_ for information on how to use these