1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
|
.. _index:
django-contact-form |release|
=============================
``django-contact-form`` provides customizable contact-form functionality for
`Django <https://www.djangoproject.com/>`_-powered Web sites.
This application includes:
* An extensible base contact-form class which is also usable as-is for basic
functionality (collecting a name, email address, and message)
* A subclass of the base form which uses the Akismet spam-filtering service to
detect and reject spam submissions
* A class-based Django view which can be used with either of the built-in
contact form classes, or your own customized form
For the default contact-form functionality, add ``"django_contact_form"`` to
your Django site's ``INSTALLED_APPS`` setting, add the following line to
your site's root URLConf, and create the templates specified in :ref:`the usage
guide <default-templates>`:
.. code-block:: python
from django.urls import include, path
urlpatterns = [
# ... other URL patterns for your site ...
path("contact/", include("django_contact_form.urls")),
]
.. toctree::
:caption: Installation and usage
:maxdepth: 1
install
usage
.. toctree::
:caption: API reference
:maxdepth: 1
forms
views
.. toctree::
:caption: Other documentation
:maxdepth: 1
changelog
faq
|