Fixed #23814 -- Documented apps refactored out of Django.

This commit is contained in:
Fabio Natali 2015-03-22 11:51:09 +00:00 committed by Tim Graham
parent 8f30556329
commit cb506aed2a
10 changed files with 51 additions and 115 deletions

View file

@ -0,0 +1,38 @@
=================
External packages
=================
Django ships with a variety of extra, optional tools that solve common
problems (``contrib.*``). For easier maintenance and to trim the size of the
codebase, a few of those applications have been moved out to separate projects.
Localflavor
~~~~~~~~~~~
``django-localflavor`` is a collection of utilities for particular countries
and cultures.
* `GitHub <https://github.com/django/django-localflavor>`__
* `Documentation <https://django-localflavor.readthedocs.org/>`__
* `PyPI <https://pypi.python.org/pypi/django-localflavor>`__
Comments
~~~~~~~~
``django-contrib-comments`` can be used to attach comments to any model, so you
can use it for comments on blog entries, photos, book chapters, or anything
else. Most users will be better served with a custom solution, or a hosted
product like Disqus.
* `GitHub <https://github.com/django/django-contrib-comments>`__
* `Documentation <http://django-contrib-comments.readthedocs.org/>`__
* `PyPI <https://pypi.python.org/pypi/django-contrib-comments>`__
Formtools
~~~~~~~~~
``django-formtools`` is a collection of assorted utilities to work with forms.
* `GitHub <https://github.com/django/django-formtools>`__
* `Documentation <http://django-formtools.readthedocs.org/>`__
* `PyPI <https://pypi.python.org/pypi/django-formtools>`__

View file

@ -21,7 +21,6 @@ Introductions to all the key parts of Django you'll need to know:
signing
email
i18n/index
localflavor
logging
pagination
python3
@ -31,3 +30,4 @@ Introductions to all the key parts of Django you'll need to know:
settings
signals
checks
external-packages

View file

@ -1,53 +0,0 @@
==========================
The "local flavor" add-ons
==========================
Historically, Django has shipped with ``django.contrib.localflavor`` --
assorted pieces of code that are useful for particular countries or cultures.
This code is now distributed separately from Django, for easier maintenance
and to trim the size of Django's codebase.
See the official documentation for more information:
https://django-localflavor.readthedocs.org/
.. _localflavor-packages:
Code is hosted on github at https://github.com/django/django-localflavor.
.. _localflavor-how-to-migrate:
How to migrate
==============
If you've used the old ``django.contrib.localflavor`` package or one of the
temporary ``django-localflavor-*`` releases, follow these two easy steps to
update your code:
1. Install the third-party ``django-localflavor`` package from PyPI.
2. Change your app's import statements to reference the new package.
For example, change this::
from django.contrib.localflavor.fr.forms import FRPhoneNumberField
...to this::
from localflavor.fr.forms import FRPhoneNumberField
The code in the new package is the same (it was copied directly from Django),
so you don't have to worry about backwards compatibility in terms of
functionality. Only the imports have changed.
.. _localflavor-deprecation-policy:
Deprecation policy
==================
In Django 1.5, importing from ``django.contrib.localflavor`` will result in a
``DeprecationWarning``. This means your code will still work, but you should
change it as soon as possible.
In Django 1.6, importing from ``django.contrib.localflavor`` will no longer
work.