Browse Source

Add impls to docs

Alec Nikolas Reiter 7 years ago
parent
commit
d7276a143e
1 changed files with 33 additions and 7 deletions
  1. 33 7
      docs/authentication.rst

+ 33 - 7
docs/authentication.rst

@@ -1,16 +1,15 @@
 .. _authentication:
 .. _authentication:
 
 
-.. module:: flaskbb.core.auth.authentication
-
 Authentication
 Authentication
 ==============
 ==============
 
 
-
 FlaskBB exposes several interfaces and hooks to customize authentication and
 FlaskBB exposes several interfaces and hooks to customize authentication and
 implementations of these. For details on the hooks see :ref:`hooks`
 implementations of these. For details on the hooks see :ref:`hooks`
 
 
-Authentication
---------------
+Authentication Interfaces
+-------------------------
+
+.. module:: flaskbb.core.auth.authentication
 
 
 .. autoclass:: AuthenticationManager
 .. autoclass:: AuthenticationManager
    :members:
    :members:
@@ -28,8 +27,22 @@ Authentication
    :members:
    :members:
    :undoc-members:
    :undoc-members:
 
 
-Reauthentication
-----------------
+
+Authentication Provided Implementations
+---------------------------------------
+
+.. module:: flaskbb.auth.services.authentication
+.. autoclass:: DefaultFlaskBBAuthProvider
+.. autoclass:: MarkFailedLogin
+.. autoclass:: BlockUnactivatedUser
+.. autoclass:: ClearFailedLogins
+.. autoclass:: PluginAuthenticationManager
+
+
+Reauthentication Interfaces
+---------------------------
+
+.. module:: flaskbb.core.auth.authentication
 
 
 .. autoclass:: ReauthenticateManager
 .. autoclass:: ReauthenticateManager
    :members:
    :members:
@@ -47,8 +60,21 @@ Reauthentication
    :members:
    :members:
    :undoc-members:
    :undoc-members:
 
 
+
+Reauthentication Provided Implementations
+-----------------------------------------
+
+.. module:: flaskbb.auth.services.reauthentication
+.. autoclass:: DefaultFlaskBBReauthProvider
+.. autoclass:: ClearFailedLoginsOnReauth
+.. autoclass:: MarkFailedReauth
+.. autoclass:: PluginReauthenticationManager
+
+
 Exceptions
 Exceptions
 ----------
 ----------
 
 
+.. module:: flaskbb.core.auth.authentication
+
 .. autoexception:: StopAuthentication
 .. autoexception:: StopAuthentication
 .. autoexception:: ForceLogout
 .. autoexception:: ForceLogout