Deprecated settings doc

diff --git a/README.rst b/README.rst
index 351f3ae10c4f4aa8227237deb6f5a9ba500e1a59..226906b2f6d344124361795a43670f8cebc07367 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -374,6 +374,39 @@ If any function returns something else beside a ``dict`` or ``None``, the
 workflow will be cut and the value returned immediately, this is useful to
 return ``HttpReponse`` instances like ``HttpResponseRedirect``.
 
+---------------
+Deprecated bits
+---------------
+
+The following settings are deprecated in favor of pipeline functions.
+
+- These settings should be avoided and override ``get_username`` pipeline entry
+  with the desired behavior::
+
+    SOCIAL_AUTH_FORCE_RANDOM_USERNAME
+    SOCIAL_AUTH_DEFAULT_USERNAME
+    SOCIAL_AUTH_UUID_LENGTH
+    SOCIAL_AUTH_USERNAME_FIXER
+
+- User creation setting should be avoided and remove the entry ``create_user``
+  from pipeline instead::
+
+    SOCIAL_AUTH_CREATE_USERS
+
+- Automatic data update should be stopped by overriding ``update_user_details``
+  pipeline entry instead of using this setting::
+
+    SOCIAL_AUTH_CHANGE_SIGNAL_ONLY
+
+- Extra data retrieval from providers should be stopped by removing
+  ``load_extra_data`` from pipeline instead of using this setting::
+
+    SOCIAL_AUTH_EXTRA_DATA
+
+- Automatic email association should be avoided by removing
+  ``associate_by_email`` pipeline entry instead of using this setting::
+
+    SOCIAL_AUTH_ASSOCIATE_BY_MAIL
 
 -------------
 Usage example

diff --git a/doc/deprecated.rst b/doc/deprecated.rst
new file mode 100644 (file)
index 0000000..60d3ff6
--- /dev/null
+++ b/doc/deprecated.rst
@@ -0,0 +1,32 @@
+Deprecated bits
+===============
+
+The following settings are deprecated in favor of pipeline functions.
+
+- These settings should be avoided and override ``get_username`` pipeline entry
+  with the desired behavior::
+
+    SOCIAL_AUTH_FORCE_RANDOM_USERNAME
+    SOCIAL_AUTH_DEFAULT_USERNAME
+    SOCIAL_AUTH_UUID_LENGTH
+    SOCIAL_AUTH_USERNAME_FIXER
+
+- User creation setting should be avoided and remove the entry ``create_user``
+  from pipeline instead::
+
+    SOCIAL_AUTH_CREATE_USERS
+
+- Automatic data update should be stopped by overriding ``update_user_details``
+  pipeline entry instead of using this setting::
+
+    SOCIAL_AUTH_CHANGE_SIGNAL_ONLY
+
+- Extra data retrieval from providers should be stopped by removing
+  ``load_extra_data`` from pipeline instead of using this setting::
+
+    SOCIAL_AUTH_EXTRA_DATA
+
+- Automatic email association should be avoided by removing
+  ``associate_by_email`` pipeline entry instead of using this setting::
+
+    SOCIAL_AUTH_ASSOCIATE_BY_MAIL

diff --git a/doc/index.rst b/doc/index.rst
index 0e05651eb239f8c9d9fce669c1e39526524e4101..68921aeff6f35a858ac557c1890a3f7f719cb751 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -16,6 +16,8 @@ Contents:
 
    backends/index
    pipeline
+   pipeline
+   deprecated
 
    signals
    contributions

diff --git a/doc/pipeline.rst b/doc/pipeline.rst
index 6c9d543095c327354599a4d1b31ee355b688e53a..d8c9f943c84912b04141d9e0386d8fa2cbb23cb3 100644 (file)
--- a/doc/pipeline.rst
+++ b/doc/pipeline.rst
@@ -51,3 +51,6 @@ is raised at any point.
 If any function returns something else beside a ``dict`` or ``None``, the
 workflow will be cut and the value returned immediately, this is useful to
 return ``HttpReponse`` instances like ``HttpResponseRedirect``.
+
+
+.. _django-social-auth: https://github.com/omab/django-social-auth