From 7f66d1a46d09b56edb4f93052a582af57ee91b55 Mon Sep 17 00:00:00 2001 From: Karl Hobley Date: Tue, 15 Jul 2014 13:45:42 +0100 Subject: [PATCH] Improvements to subpage_urls docs --- docs/routable_page.rst | 13 +++++++++++-- wagtail/contrib/wagtailroutablepage/models.py | 1 + 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/routable_page.rst b/docs/routable_page.rst index e15fd5a83..0b982752d 100644 --- a/docs/routable_page.rst +++ b/docs/routable_page.rst @@ -53,9 +53,18 @@ The ``RoutablePage`` class .. automodule:: wagtail.contrib.wagtailroutablepage.models .. autoclass:: RoutablePage - .. attribute:: subpage_urls + .. autoattribute:: subpage_urls - Set this to a tuple of ``django.conf.urls.url`` objects. + Example: + + .. code-block:: python + + from django.conf.urls import url + + subpage_urls = ( + url(r'^$', 'serve', name='main'), + url(r'^archive/$', 'archive', name='archive'), + ) .. automethod:: resolve_subpage diff --git a/wagtail/contrib/wagtailroutablepage/models.py b/wagtail/contrib/wagtailroutablepage/models.py index c5449b0fd..f853208af 100644 --- a/wagtail/contrib/wagtailroutablepage/models.py +++ b/wagtail/contrib/wagtailroutablepage/models.py @@ -12,6 +12,7 @@ class RoutablePage(Page): """ This class extends Page by adding methods to allow urlconfs to be embedded inside pages """ + #: Set this to a tuple of ``django.conf.urls.url`` objects. subpage_urls = None def reverse_subpage(self, name, args=None, kwargs=None):