From a855749f5e7122eeb10e69a41e4cebf632c74a06 Mon Sep 17 00:00:00 2001
From: Karl Hobley <karl@torchbox.com>
Date: Mon, 14 Jul 2014 15:09:22 +0100
Subject: [PATCH] Started RoutablePage docs

---
 docs/routable_page.rst | 75 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 docs/routable_page.rst

diff --git a/docs/routable_page.rst b/docs/routable_page.rst
new file mode 100644
index 0000000000..e15fd5a836
--- /dev/null
+++ b/docs/routable_page.rst
@@ -0,0 +1,75 @@
+============
+RoutablePage
+============
+
+.. versionadded:: 0.5
+
+This document describes how to use Wagtails ``RoutablePage`` class. This class is designed for embedding URL configuration into pages.
+
+
+The basics
+==========
+
+To use ``RoutablePage``. You need to make your class inherit from :class:`wagtail.contrib.wagtailroutablepage.models.RoutablePage` and configure the ``subpage_urls`` attribute with your URL configuration.
+
+Heres a quick example of en ``EventPage`` with three views:
+
+.. code-block:: python
+
+    from django.conf.urls import url
+
+    from wagtail.contrib.wagtailroutablepage.models import RoutablePage
+
+
+    class EventPage(RoutablePage):
+        subpage_urls = (
+            url(r'^$', 'current_events', name='current_events'),
+            url(r'^past/$', 'past_events', name='past_events'),
+            url(r'^year/(\d+)/$', 'events_for_year', name='events_for_year'),
+        )
+
+        def current_events(self, request):
+            """
+            View function for the current events page
+            """
+            ...
+
+        def past_events(self, request):
+            """
+            View function for the current events page
+            """
+            ...
+
+        def events_for_year(self, request):
+            """
+            View function for the events for year page
+            """
+            ...
+
+
+The ``RoutablePage`` class
+==========================
+
+.. automodule:: wagtail.contrib.wagtailroutablepage.models
+.. autoclass:: RoutablePage
+
+    .. attribute:: subpage_urls
+
+        Set this to a tuple of ``django.conf.urls.url`` objects.
+
+    .. automethod:: resolve_subpage
+
+        Example:
+
+        .. code-block:: python
+
+            view, args, kwargs = page.resolve_subpage('/past/')
+            response = view(request, *args, **kwargs)
+
+    .. automethod:: reverse_subpage
+
+        Example:
+
+        .. code-block:: python
+
+            url = page.url + page.reverse_subpage('events_for_year', args=('2014', ))