From 00347ff6ba0bd75cb22d460f6e67dcac4dcbe750 Mon Sep 17 00:00:00 2001 From: Karl Hobley Date: Thu, 3 Jul 2014 12:53:11 +0100 Subject: [PATCH] Rearrange static site generation docs --- docs/static_site_generation.rst | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/static_site_generation.rst b/docs/static_site_generation.rst index a9379cd671..9feb59c368 100644 --- a/docs/static_site_generation.rst +++ b/docs/static_site_generation.rst @@ -25,8 +25,19 @@ Then add ``django_medusa`` and ``wagtail.contrib.wagtailmedusa`` to ``INSTALLED_ ] +Rendering +~~~~~~~~~ + +To render a site, run ``./manage.py staticsitegen``. This will render the entire website and place the HTML in a folder called 'medusa_output'. The static and media folders need to be copied into this folder manually after the rendering is complete. This feature inherits django-medusa's ability to render your static site to Amazon S3 or Google App Engine; see the `medusa docs `_ for configuration details. + +To test, open the 'medusa_output' folder in a terminal and run ``python -m SimpleHTTPServer``. + + +Advanced topics +~~~~~~~~~~~~~~~ + Replacing GET parameters with custom routing -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------------------------- Pages which require GET parameters (e.g. for pagination) don't generate suitable filenames for generated HTML files so they need to be changed to use custom routing instead. @@ -51,7 +62,7 @@ For example, let's say we have a Blog Index which uses pagination. We can overri Rendering pages which use custom routing -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +---------------------------------------- For page types that override the ``route`` method, we need to let django medusa know which URLs it responds on. This is done by overriding the ``get_static_site_paths`` method to make it yield one string per URL path. @@ -72,12 +83,4 @@ For example, the BlogIndex above would need to yield one URL for each page of re yield path -Rendering -~~~~~~~~~ - -To render a site, run ``./manage.py staticsitegen``. This will render the entire website and place the HTML in a folder called 'medusa_output'. The static and media folders need to be copied into this folder manually after the rendering is complete. This feature inherits django-medusa's ability to render your static site to Amazon S3 or Google App Engine; see the `medusa docs `_ for configuration details. - -To test, open the 'medusa_output' folder in a terminal and run ``python -m SimpleHTTPServer``. - - .. _django medusa: https://github.com/mtigas/django-medusa