Skip to content

Commit

Permalink
More documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
ubernostrum committed Nov 8, 2024
1 parent 4ee9804 commit a85a848
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 21 deletions.
38 changes: 34 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,39 @@
:target: https://github.com/ubernostrum/django-registration/actions?query=workflow%3ACI

This is a user-registration application for `Django
<https://www.djangoproject.com/>`_. There are two registration
workflows (one-step, and two-step with activation) built in, and it's
designed to be extensible and support building additional workflows.
<https://www.djangoproject.com/>`_ sites.

To get started, check out `the documentation
It has built-in support for:

* User registration with the default Django user model

* User registration with many custom user models

* Two-step (email an activation link) registration

* One-step (register and be immediately logged in) registration

And is designed to be extensible to support use cases beyond what's
built in.

For example, to enable one-step registration, you'd add
``"django_registration"`` to your Django ``INSTALLED_APPS`` setting,
then add the following to your site's root URLconfig:

.. code-block:: python
from django.urls import include, path
urlpatterns = [
# Other URL patterns ...
path("accounts/", include("django_registration.backends.one_step.urls")),
path("accounts/", include("django.contrib.auth.urls")),
# More URL patterns ...
]
And create a few templates (see `the quick start guide
<https://django-registration.readthedocs.io/en/stable/quickstart.html>`_
for details).

For more, check out `the full documentation
<https://django-registration.readthedocs.io/>`_.
49 changes: 34 additions & 15 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,44 @@
django-registration |release|
=============================

django-registration is an extensible application providing user registration
functionality for `Django <https://www.djangoproject.com/>`_-powered Web sites.
``django-registration`` is an extensible application providing user
registration functionality for `Django <https://www.djangoproject.com/>`_
sites.

Although nearly all aspects of the registration process are customizable,
out-of-the-box support is provided for two common use cases:
It has built-in support for:

* Two-phase registration, consisting of initial signup followed by a
confirmation email with instructions for activating the new account.
* User registration with the default Django user model

* One-phase registration, where a user signs up and is immediately active and
logged in.
* User registration with many custom user models

To get up and running quickly, :ref:`install django-registration <install>`,
then read :ref:`the quick start guide <quickstart>`, which describes the steps
necessary to configure django-registration for the built-in workflows. For more
detailed information, including how to customize the registration process (and
support for alternate registration systems), read through the documentation
listed below.
* Two-step (email an activation link) registration

* One-step (register and be immediately logged in) registration

And is designed to be extensible to support use cases beyond what's
built in.

For example, to enable one-step registration, you'd add
``"django_registration"`` to your Django ``INSTALLED_APPS`` setting,
then add the following to your site's root URLconfig:

.. code-block:: python
from django.urls import include, path
urlpatterns = [
# Other URL patterns ...
path("accounts/", include("django_registration.backends.one_step.urls")),
path("accounts/", include("django.contrib.auth.urls")),
# More URL patterns ...
]
And create a few templates (see :ref:`the quick start guide <quickstart>` for
full details).


Documentation contents
----------------------

.. toctree::
:caption: Installation and configuration
Expand Down Expand Up @@ -62,5 +81,5 @@ listed below.

* `Django's authentication documentation
<https://docs.djangoproject.com/en/stable/topics/auth/>`_. Django's
authentication system is used by django-registration's default
authentication system is used by ``django-registration``'s default
configuration.
9 changes: 7 additions & 2 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,13 @@ To use the activation workflow, you'll need to:
Required settings
~~~~~~~~~~~~~~~~~

Make sure you've added ``"django_registration"`` to your ``INSTALLED_APPS``
list. Then add the following new setting to your Django settings file:
Because this workflow sends the activation code via email, you'll need to
configure `Django's email-sending functionality
<https://docs.djangoproject.com/en/5.1/topics/email/>`_.

Also, make sure you've added ``"django_registration"`` to your
``INSTALLED_APPS`` list. Then add the following new setting to your Django
settings file:

:data:`~django.conf.settings.ACCOUNT_ACTIVATION_DAYS`
This is an :class:`int` specifying the number of days users will have to
Expand Down

0 comments on commit a85a848

Please sign in to comment.