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

@ -243,7 +243,6 @@ regions:
:doc:`Internationalization <topics/i18n/translation>` | :doc:`Internationalization <topics/i18n/translation>` |
:ref:`Localization <how-to-create-language-files>` | :ref:`Localization <how-to-create-language-files>` |
:doc:`Localized Web UI formatting and form input <topics/i18n/formatting>` :doc:`Localized Web UI formatting and form input <topics/i18n/formatting>`
* :doc:`"Local flavor" <topics/localflavor>`
* :doc:`Time zones </topics/i18n/timezones>` * :doc:`Time zones </topics/i18n/timezones>`
Performance and optimization Performance and optimization

View File

@ -1,43 +0,0 @@
django.contrib.formtools
========================
A set of high-level abstractions for Django forms (:mod:`django.forms`).
Historically, Django shipped with ``django.contrib.formtools`` -- a collection
of assorted utilities that are useful for specific form use cases. This code is
now distributed separately from Django, for easier maintenance and to trim the
size of Django's codebase. In Django 1.8, importing from
``django.contrib.formtools`` will no longer work.
The new formtools package is named ``django-formtools``, with a main module
called ``formtools``. Version 1.0 includes the same two primary features that
the code included when it shipped with Django: a helper for form previews and a
form wizard view.
See the `official documentation`_ for more information.
.. _official documentation: http://django-formtools.readthedocs.org/
.. _formtools-how-to-migrate:
How to migrate
--------------
If you've used the old ``django.contrib.formtools`` package follow these
two easy steps to update your code:
1. Install version 1.0 of the third-party ``django-formtools`` package.
2. Change your app's import statements to reference the new packages.
For example, change::
from django.contrib.formtools.wizard.views import WizardView
to::
from formtools.wizard.views import WizardView
The code in version 1.0 of 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.

View File

@ -26,7 +26,6 @@ those packages have.
auth auth
contenttypes contenttypes
flatpages flatpages
formtools/index
gis/index gis/index
humanize humanize
messages messages

View File

@ -13,9 +13,11 @@ This document contains all the API references of :class:`Field` including the
.. seealso:: .. seealso::
If the built-in fields don't do the trick, you can try `django-localflavor If the built-in fields don't do the trick, you can try `django-localflavor
<https://django-localflavor.readthedocs.org/>`_, which contains assorted <https://github.com/django/django-localflavor>`_ (`documentation
pieces of code that are useful for particular countries or cultures. Also, <https://django-localflavor.readthedocs.org/>`_), which contains assorted
you can easily :doc:`write your own custom model fields pieces of code that are useful for particular countries and cultures.
Also, you can easily :doc:`write your own custom model fields
</howto/custom-model-fields>`. </howto/custom-model-fields>`.
.. note:: .. note::

View File

@ -1885,11 +1885,7 @@ The secret key is used for:
* All :doc:`messages </ref/contrib/messages>` if you are using * All :doc:`messages </ref/contrib/messages>` if you are using
:class:`~django.contrib.messages.storage.cookie.CookieStorage` or :class:`~django.contrib.messages.storage.cookie.CookieStorage` or
:class:`~django.contrib.messages.storage.fallback.FallbackStorage`. :class:`~django.contrib.messages.storage.fallback.FallbackStorage`.
* :mod:`Form wizard <formtools.wizard.views>` progress when using
cookie storage with
:class:`formtools.wizard.views.CookieWizardView`.
* All :func:`~django.contrib.auth.views.password_reset` tokens. * All :func:`~django.contrib.auth.views.password_reset` tokens.
* All in progress :mod:`form previews <formtools.preview>`.
* Any usage of :doc:`cryptographic signing </topics/signing>`, unless a * Any usage of :doc:`cryptographic signing </topics/signing>`, unless a
different key is provided. different key is provided.

View File

@ -723,13 +723,12 @@ Features deprecated in 1.5
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The localflavor contrib app has been split into separate packages. The localflavor contrib app has been split into separate packages.
``django.contrib.localflavor`` itself will be removed in Django 1.6, after an ``django.contrib.localflavor`` itself will be removed in Django 1.6,
:ref:`accelerated deprecation <localflavor-deprecation-policy>`. The docs after an accelerated deprecation.
provide :ref:`migration instructions <localflavor-how-to-migrate>`.
The new packages are available :ref:`on Github <localflavor-packages>`. The The new packages are available on Github. The core team cannot
core team cannot efficiently maintain these packages in the long term — it efficiently maintain these packages in the long term — it spans just a
spans just a dozen countries at this time; similar to translations, maintenance dozen countries at this time; similar to translations, maintenance
will be handed over to interested members of the community. will be handed over to interested members of the community.
``django.contrib.markup`` ``django.contrib.markup``

View File

@ -908,9 +908,8 @@ class decorators. As a consequence, when overriding ``setUpClass()`` or
Removal of ``django.contrib.formtools`` Removal of ``django.contrib.formtools``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The formtools contrib app has been moved into a separate package. The formtools contrib app has been moved to a separate package and the
``django.contrib.formtools`` itself has been removed. The docs provide relevant documentation pages have been updated or removed.
:ref:`migration instructions <formtools-how-to-migrate>`.
The new package is available `on Github`_ and on PyPI. The new package is available `on Github`_ and on PyPI.

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 signing
email email
i18n/index i18n/index
localflavor
logging logging
pagination pagination
python3 python3
@ -31,3 +30,4 @@ Introductions to all the key parts of Django you'll need to know:
settings settings
signals signals
checks 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.