Fixes docs

This commit is contained in:
Michael 2020-02-29 23:18:19 -06:00
parent 7d63b53a43
commit 9298014b3a
3 changed files with 11 additions and 12 deletions

View File

@ -6,9 +6,8 @@
Welcome to dj-rest-auth's documentation!
============================================
.. warning:: Updating dj-rest-auth from version **0.3.3** is highly recommended because of a security issue in PasswordResetConfirmation validation method.
.. note:: dj-rest-auth from v0.3.3 supports django-rest-framework v3.0
.. note:: dj-rest-auth from v0.3.3 supports django-rest-framework >= v3.0
|build-status| |coverage-status| |requirements-status| |docs|

View File

@ -28,7 +28,7 @@ Installation
urlpatterns = [
...,
url(r'^rest-auth/', include('dj_rest_auth.urls'))
url(r'^dj-rest-auth/', include('dj_rest_auth.urls'))
]
4. Migrate your database
@ -68,8 +68,8 @@ Registration (optional)
urlpatterns = [
...,
url(r'^rest-auth/', include('dj_rest_auth.urls')),
url(r'^rest-auth/registration/', include('dj_rest_auth.registration.urls'))
url(r'^dj-rest-auth/', include('dj_rest_auth.urls')),
url(r'^dj-rest-auth/registration/', include('dj_rest_auth.registration.urls'))
]
@ -122,7 +122,7 @@ Facebook
urlpatterns += [
...,
url(r'^rest-auth/facebook/$', FacebookLogin.as_view(), name='fb_login')
url(r'^dj-rest-auth/facebook/$', FacebookLogin.as_view(), name='fb_login')
]
@ -149,7 +149,7 @@ If you are using Twitter for your social authentication, it is a bit different s
urlpatterns += [
...,
url(r'^rest-auth/twitter/$', TwitterLogin.as_view(), name='twitter_login')
url(r'^dj-rest-auth/twitter/$', TwitterLogin.as_view(), name='twitter_login')
]
.. note:: Starting from v0.21.0, django-allauth has dropped support for context processors. Check out http://django-allauth.readthedocs.org/en/latest/changelog.html#from-0-21-0 for more details.
@ -179,7 +179,7 @@ If you are using GitHub for your social authentication, it uses code and not Acc
urlpatterns += [
...,
url(r'^rest-auth/github/$', GitHubLogin.as_view(), name='github_login')
url(r'^dj-rest-auth/github/$', GitHubLogin.as_view(), name='github_login')
]
Additional Social Connect Views
@ -215,9 +215,9 @@ In urls.py:
urlpatterns += [
...,
url(r'^rest-auth/facebook/connect/$', FacebookConnect.as_view(), name='fb_connect')
url(r'^rest-auth/twitter/connect/$', TwitterConnect.as_view(), name='twitter_connect')
url(r'^rest-auth/github/connect/$', GithubConnect.as_view(), name='github_connect')
url(r'^dj-rest-auth/facebook/connect/$', FacebookConnect.as_view(), name='fb_connect')
url(r'^dj-rest-auth/twitter/connect/$', TwitterConnect.as_view(), name='twitter_connect')
url(r'^dj-rest-auth/github/connect/$', GithubConnect.as_view(), name='github_connect')
]
You can also use the following views to check all social accounts attached to the current authenticated user and disconnect selected social accounts:

View File

@ -12,7 +12,7 @@ f.close()
setup(
name='dj-rest-auth',
version='0.1.0',
version='0.1.1',
author='iMerica',
author_email='imichael@pm.me',
url='http://github.com/iMerica/dj-rest-auth',