From cb506aed2a3ca439a7ed6cff410667f302405c8b Mon Sep 17 00:00:00 2001 From: Fabio Natali Date: Sun, 22 Mar 2015 11:51:09 +0000 Subject: [PATCH] Fixed #23814 -- Documented apps refactored out of Django. --- docs/index.txt | 1 - docs/ref/contrib/formtools/index.txt | 43 ---------------------- docs/ref/contrib/index.txt | 1 - docs/ref/models/fields.txt | 8 +++-- docs/ref/settings.txt | 4 --- docs/releases/1.5.txt | 11 +++--- docs/releases/1.8.txt | 5 ++- docs/topics/external-packages.txt | 38 ++++++++++++++++++++ docs/topics/index.txt | 2 +- docs/topics/localflavor.txt | 53 ---------------------------- 10 files changed, 51 insertions(+), 115 deletions(-) delete mode 100644 docs/ref/contrib/formtools/index.txt create mode 100644 docs/topics/external-packages.txt delete mode 100644 docs/topics/localflavor.txt diff --git a/docs/index.txt b/docs/index.txt index 814b93418d..575d27ed66 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -243,7 +243,6 @@ regions: :doc:`Internationalization ` | :ref:`Localization ` | :doc:`Localized Web UI formatting and form input ` -* :doc:`"Local flavor" ` * :doc:`Time zones ` Performance and optimization diff --git a/docs/ref/contrib/formtools/index.txt b/docs/ref/contrib/formtools/index.txt deleted file mode 100644 index da5e02d4a3..0000000000 --- a/docs/ref/contrib/formtools/index.txt +++ /dev/null @@ -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. diff --git a/docs/ref/contrib/index.txt b/docs/ref/contrib/index.txt index 9f7754a7c1..b2b331476e 100644 --- a/docs/ref/contrib/index.txt +++ b/docs/ref/contrib/index.txt @@ -26,7 +26,6 @@ those packages have. auth contenttypes flatpages - formtools/index gis/index humanize messages diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 0b411cf729..3746813bfb 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -13,9 +13,11 @@ This document contains all the API references of :class:`Field` including the .. seealso:: If the built-in fields don't do the trick, you can try `django-localflavor - `_, which contains assorted - pieces of code that are useful for particular countries or cultures. Also, - you can easily :doc:`write your own custom model fields + `_ (`documentation + `_), which contains assorted + pieces of code that are useful for particular countries and cultures. + + Also, you can easily :doc:`write your own custom model fields `. .. note:: diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index 5bf53ca76d..0763799651 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1885,11 +1885,7 @@ The secret key is used for: * All :doc:`messages ` if you are using :class:`~django.contrib.messages.storage.cookie.CookieStorage` or :class:`~django.contrib.messages.storage.fallback.FallbackStorage`. -* :mod:`Form wizard ` progress when using - cookie storage with - :class:`formtools.wizard.views.CookieWizardView`. * All :func:`~django.contrib.auth.views.password_reset` tokens. -* All in progress :mod:`form previews `. * Any usage of :doc:`cryptographic signing `, unless a different key is provided. diff --git a/docs/releases/1.5.txt b/docs/releases/1.5.txt index 8838f1983d..63a4e4d798 100644 --- a/docs/releases/1.5.txt +++ b/docs/releases/1.5.txt @@ -723,13 +723,12 @@ Features deprecated in 1.5 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The localflavor contrib app has been split into separate packages. -``django.contrib.localflavor`` itself will be removed in Django 1.6, after an -:ref:`accelerated deprecation `. The docs -provide :ref:`migration instructions `. +``django.contrib.localflavor`` itself will be removed in Django 1.6, +after an accelerated deprecation. -The new packages are available :ref:`on Github `. The -core team cannot efficiently maintain these packages in the long term — it -spans just a dozen countries at this time; similar to translations, maintenance +The new packages are available on Github. The core team cannot +efficiently maintain these packages in the long term — it spans just a +dozen countries at this time; similar to translations, maintenance will be handed over to interested members of the community. ``django.contrib.markup`` diff --git a/docs/releases/1.8.txt b/docs/releases/1.8.txt index a0a27ee89e..e44181acc3 100644 --- a/docs/releases/1.8.txt +++ b/docs/releases/1.8.txt @@ -908,9 +908,8 @@ class decorators. As a consequence, when overriding ``setUpClass()`` or Removal of ``django.contrib.formtools`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The formtools contrib app has been moved into a separate package. -``django.contrib.formtools`` itself has been removed. The docs provide -:ref:`migration instructions `. +The formtools contrib app has been moved to a separate package and the +relevant documentation pages have been updated or removed. The new package is available `on Github`_ and on PyPI. diff --git a/docs/topics/external-packages.txt b/docs/topics/external-packages.txt new file mode 100644 index 0000000000..29a6c3dc41 --- /dev/null +++ b/docs/topics/external-packages.txt @@ -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 `__ +* `Documentation `__ +* `PyPI `__ + +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 `__ +* `Documentation `__ +* `PyPI `__ + +Formtools +~~~~~~~~~ + +``django-formtools`` is a collection of assorted utilities to work with forms. + +* `GitHub `__ +* `Documentation `__ +* `PyPI `__ diff --git a/docs/topics/index.txt b/docs/topics/index.txt index e27f28112b..5521cd1c0e 100644 --- a/docs/topics/index.txt +++ b/docs/topics/index.txt @@ -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 diff --git a/docs/topics/localflavor.txt b/docs/topics/localflavor.txt deleted file mode 100644 index 5e9199c8e0..0000000000 --- a/docs/topics/localflavor.txt +++ /dev/null @@ -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.