@@ -43,7 +43,9 @@ Run this command to install ``django-mail-auth``::
43
43
Setup
44
44
-----
45
45
46
- First add ``mailauth `` to you installed apps::
46
+ First add ``mailauth `` to you installed apps:
47
+
48
+ .. code-block :: python
47
49
48
50
INSTALLED_APPS = [
49
51
# Django's builtin apps…
@@ -64,7 +66,9 @@ First add ``mailauth`` to you installed apps::
64
66
with token based authentication too.
65
67
66
68
``mailauth.contrib.user `` is optional and provides a new Django User model.
67
- The new User model needs to be enabled via the ``AUTH_USER_MODEL `` setting::
69
+ The new User model needs to be enabled via the ``AUTH_USER_MODEL `` setting:
70
+
71
+ .. code-block :: python
68
72
69
73
# This setting should be either "EmailUser" or
70
74
# any custom subclass of "AbstractEmailUser"
@@ -74,7 +78,9 @@ The new User model needs to be enabled via the ``AUTH_USER_MODEL`` setting::
74
78
WAGTAILUSERS_PASSWORD_ENABLED = False
75
79
76
80
77
- Next you will need to add the new authentication backend::
81
+ Next you will need to add the new authentication backend:
82
+
83
+ .. code-block :: python
78
84
79
85
AUTHENTICATION_BACKENDS = (
80
86
# default, but now optional
@@ -89,7 +95,9 @@ Next you will need to add the new authentication backend::
89
95
Django's ``ModelBackend `` is only needed, if you still want to support
90
96
password based authentication. If you don't, simply remove it from the list.
91
97
92
- Last but not least, go to your URL root configuration ``urls.py `` and add the following::
98
+ Last but not least, go to your URL root configuration ``urls.py `` and add the following:
99
+
100
+ .. code-block :: python
93
101
94
102
from django.urls import path
95
103
@@ -107,12 +115,12 @@ That's it!
107
115
108
116
.. |version | image :: https://img.shields.io/pypi/v/django-mail-auth.svg
109
117
:target: https://pypi.python.org/pypi/django-mail-auth/
110
- .. |ci | image :: https://travis-ci.com/codingjoe/django-mail-auth.svg?branch=master
118
+ .. |ci | image :: https://travis-ci.com/codingjoe/django-mail-auth.svg?branch=main
111
119
:target: https://travis-ci.com/codingjoe/django-mail-auth
112
- .. |coverage | image :: https://codecov.io/gh/codingjoe/django-mail-auth/branch/master /graph/badge.svg
120
+ .. |coverage | image :: https://codecov.io/gh/codingjoe/django-mail-auth/branch/main /graph/badge.svg
113
121
:target: https://codecov.io/gh/codingjoe/django-mail-auth
114
122
.. |license | image :: https://img.shields.io/badge/license-MIT-blue.svg
115
- :target: :target: https://raw.githubusercontent.com/codingjoe/django-mail-auth/master /LICENSE
123
+ :target: :target: https://raw.githubusercontent.com/codingjoe/django-mail-auth/main /LICENSE
116
124
.. |docs | image :: https://readthedocs.org/projects/django-mail-auth/badge/?version=latest
117
125
:target: https://django-mail-auth.readthedocs.io/en/latest/?badge=latest
118
126
:alt: Documentation Status
0 commit comments