From f9fba4fb3e6f6906821ed0f39e6d11cb0f26ce9d Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 26 May 2019 10:13:49 -0700 Subject: API docs. --- docs/api/authentication.rst | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) (limited to 'docs/api/authentication.rst') diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst index 57f32327a..835d46de0 100644 --- a/docs/api/authentication.rst +++ b/docs/api/authentication.rst @@ -3,11 +3,28 @@ :mod:`pyramid.authentication` -------------------------------- -Authentication Policies -~~~~~~~~~~~~~~~~~~~~~~~ +Helper Classes +~~~~~~~~~~~~~~ .. automodule:: pyramid.authentication + .. autoclass:: SessionAuthenticationHelper + :members: + + .. autoclass:: AuthTktCookieHelper + :members: + + .. autoclass:: HTTPBasicCredentials + :members: + +Helper Functions +~~~~~~~~~~~~~~~~ + + .. autofunction:: extract_http_basic_credentials + +Authentication Policies +~~~~~~~~~~~~~~~~~~~~~~~ + .. autoclass:: AuthTktAuthenticationPolicy :members: :inherited-members: @@ -27,17 +44,3 @@ Authentication Policies .. autoclass:: RepozeWho1AuthenticationPolicy :members: :inherited-members: - -Helper Classes -~~~~~~~~~~~~~~ - - .. autoclass:: AuthTktCookieHelper - :members: - - .. autoclass:: HTTPBasicCredentials - :members: - -Helper Functions -~~~~~~~~~~~~~~~~ - - .. autofunction:: extract_http_basic_credentials -- cgit v1.2.3 From c69994778de79041d703fd121ec9d1aaf8a6b7c8 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sat, 13 Jul 2019 10:10:46 -0700 Subject: Improve authn/authz API docs. --- docs/api/authentication.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'docs/api/authentication.rst') diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst index 835d46de0..f3a25ee64 100644 --- a/docs/api/authentication.rst +++ b/docs/api/authentication.rst @@ -14,17 +14,20 @@ Helper Classes .. autoclass:: AuthTktCookieHelper :members: - .. autoclass:: HTTPBasicCredentials - :members: - Helper Functions ~~~~~~~~~~~~~~~~ .. autofunction:: extract_http_basic_credentials + .. autoclass:: HTTPBasicCredentials + :members: + Authentication Policies ~~~~~~~~~~~~~~~~~~~~~~~ +Authentication policies have been deprecated by the new security system. See +:ref:`upgrading_auth` for more information. + .. autoclass:: AuthTktAuthenticationPolicy :members: :inherited-members: -- cgit v1.2.3