Merge pull request #165 from ababic/release-prep/2.4.0

Prep for 2.4.0 release

CHANGELOG.md

@@ -1,9 +1,21 @@
 Changelog
 =========
 
-2.4.0 (XX.XX.XXX) IN DEVELOPMENT
--------------------------------- 
-
+2.X.X (XX.XX.XXXX) IN DEVELOPMENT
+--------------------------------- 
+
+2.4.0 (04.08.2017)
+------------------ 
+
+* Adjusted Meta classes on menu item models so that common behaviour is defined
+  once in AbastractMenuItem.Meta.
+* Refactored the AbstractMenuItem's `menu_text` property method to improve code
+  readability, and better handle instances where neither link_text or link_page
+  are set.
+* Replaced overly long README.md with brand new documentation and a new 
+  README.rst which will render better on PyPi. The documentation is kindly 
+  hosted by readthedocs.org and can be found at 
+  http://wagtailmenus.readthedocs.io/
 * Added the 'use_absolute_page_urls' argument to all template tags. When a 
   value equating to `True` is provided, the menu will be rendered using the 
   'full URL' for each page (including the protocol/domain derived from the 
@@ -12,7 +24,7 @@ Changelog
 
 
 2.3.2 (21.07.2017)
--------------------------------- 
+------------------ 
 
 * Fixed a bug that would result in {% sub_menu %} being called recursively (
   until raising a "maximum recursion depth exceeded" exception) if a 
@@ -21,7 +33,7 @@ Changelog
 
 
 2.3.1 (01.07.2017)
--------------------------------- 
+------------------ 
 
 * Code example formatting fixes, and better use of headings in README.md.
 * Added 'on_delete=models.CASCADE' to all relationship fields on models where
@@ -32,7 +44,7 @@ Changelog
 
 
 2.3.0 (21.06.2017)
--------------------------------- 
+------------------
 
 * Added an 'AbstractLinkPage' model to wagtailmenus.models that can be easily
   sub-classed and used in projects to create 'link pages' that act in a similar
@@ -67,7 +79,7 @@ Changelog
 
 
 2.2.3 (21.07.2017)
--------------------------------- 
+------------------
 
 * Fixed a bug that would result in {% sub_menu %} being called recursively (
   until raising a "maximum recursion depth exceeded" exception) if a 
@@ -76,7 +88,7 @@ Changelog
 
 
 2.2.2 (27.03.2017)
--------------------------------- 
+------------------
 
 * Got project set up in Transifex.
 * Updated translatable strings throughout the project to use named variable
@@ -87,7 +99,7 @@ Changelog
 
 
 2.2.1 (06.03.2017)
--------------------------------- 
+------------------
 
 * Updated travis/tox test settings to test against Wagtail 1.9 & Django 1.10.
 * Removed a couple of less useful travis/tox environment tests to help with
@@ -102,7 +114,7 @@ Changelog
 
 
 2.2.0 (20.02.2017)
--------------------------------- 
+------------------
 
 * Utilise Django's 'django.template.loader.select_template()' method
   to provide a more intuitive way for developers to override templates for
@@ -121,7 +133,7 @@ Changelog
 
 
 2.1.4 (21.07.2017)
--------------------------------- 
+------------------
 
 * Fixed a bug that would result in {% sub_menu %} being called recursively (
   until raising a "maximum recursion depth exceeded" exception) if a 
@@ -130,7 +142,7 @@ Changelog
 
 
 2.1.3 (20.01.2017)
--------------------------------- 
+------------------
 
 * Fixed a bug in the `section_menu` tag when attempting to apply the correct
   active class to `section_root` when the `modify_submenu_items()` method has 
@@ -139,21 +151,21 @@ Changelog
 
 
 2.1.2 (07.01.2017)
--------------------------------- 
+------------------
 
 * Fixed a bug preventing reordered menu items from retaining their new order 
   after saving. The Meta class on the new abstract models had knocked out the
   `sort_order` ordering from `wagtail.wagtailcore.models.Orderable`.
 
 
 2.1.1 (02.01.2017)
--------------------------------- 
+------------------ 
 
 * Fixed import error on pip install from version 2.1.0 (Adriaan Tijsseling)
 
 
 2.1.0 (28.12.2016)
--------------------------------- 
+------------------
 
 * Added official support for wagtail v1.8.
 * Turned `wagtailmenus.app_settings` into a real settings module.
@@ -171,19 +183,19 @@ Changelog
 
 
 2.0.3 (08.12.2016)
--------------------------------- 
+------------------
 
 Fixed migration related issue raised by @urlsangel.
 
 
 2.0.2 (08.12.2016)
--------------------------------- 
+------------------ 
 
 This release is broken and shouldn't be used. Skip to v2.0.3 instead.
 
 
 2.0.1 (22.11.2016)
--------------------------------- 
+------------------
 
 Bug fix for `main_menu` template tag.
 

docs/source/contributing/packaging_releases.rst

@@ -29,8 +29,8 @@ Follow the steps outlined below to prep changes in your fork:
 4.  Make sure ``CHANGELOG.md`` is updated with details of any changes since
     the last release.
 
-5.  Make sure the release notes for the new version in have been created /
-    updated in ``docs/source/releases/`` and is referenced in 
+5.  Make sure the release notes for the new version have been created /
+    updated in ``docs/source/releases/`` and are referenced in 
     ``docs/source/releases/index.rst``.
 
 6.  If releasing a 'final' version, following an 'alpha' or 'beta' release, 

docs/source/releases/2.4.0a.rst → docs/source/releases/2.4.0.rst

@@ -1,9 +1,6 @@
-=================================
-Wagtailmenus 2.4.0a release notes
-=================================
-
-.. NOTE::
-    This version is still in development
+================================
+Wagtailmenus 2.4.0 release notes
+================================
 
 .. contents::
     :local:
@@ -16,7 +13,8 @@ What's new?
 Check out the new documentation!
 --------------------------------
 
-It's been on the cards for a long time, and I finally got around to making it happen!
+It's been a long wait, but I finally got around to making it happen. Wagtailmenus now has
+easily navigatable and searchable documentation, kindly hosted by readthedocs.org. Find it at http://wagtailmenus.readthedocs.io/
 
 
 New ``get_text_for_repeated_menu_item()`` method on ``MenuPageMixin`` and ``MenuPage`` models
@@ -39,6 +37,16 @@ for pages (including the protocol/domain derived from the relevant
 default.
 
 
+Other minor changes
+===================
+
+*   Adjusted Meta classes on menu item models so that common behaviour is
+    defined once in AbastractMenuItem.Meta.
+*   Refactored the AbstractMenuItem's `menu_text` property method to improve
+    code readability, and better handle instances where neither link_text or 
+    link_page are set.
+
+
 Upgrade considerations
 ======================
 

docs/source/releases/index.rst

@@ -5,7 +5,7 @@ Release notes
 .. toctree::
     :maxdepth: 1
 
-    2.4.0a
+    2.4.0
     2.3.2
     2.3.1
     2.3.0

wagtailmenus/__init__.py

@@ -3,7 +3,7 @@
 
 # major.minor.patch.release.number
 # release must be one of alpha, beta, rc, or final
-VERSION = (2, 4, 0, 'alpha', 0)
+VERSION = (2, 4, 0, 'final', 0)
 __version__ = get_version(VERSION)
 stable_branch_name = get_stable_branch_name(VERSION)
 

wagtailmenus/utils/deprecation.py

@@ -1,16 +1,16 @@
 from __future__ import absolute_import, unicode_literals
 
 
-class RemovedInWagtailMenus24Warning(DeprecationWarning):
+class RemovedInWagtailMenus25Warning(DeprecationWarning):
     pass
 
 
-removed_in_next_version_warning = RemovedInWagtailMenus24Warning
+removed_in_next_version_warning = RemovedInWagtailMenus25Warning
 
 
-class RemovedInWagtailMenus25Warning(PendingDeprecationWarning):
+class RemovedInWagtailMenus26Warning(PendingDeprecationWarning):
     pass
 
 
-class RemovedInWagtailMenus26Warning(PendingDeprecationWarning):
+class RemovedInWagtailMenus27Warning(PendingDeprecationWarning):
     pass