aboutsummaryrefslogtreecommitdiffstats
path: root/docs/howto/setup.rst
diff options
context:
space:
mode:
authortom christie tom@tomchristie.com2011-02-19 13:12:35 +0000
committertom christie tom@tomchristie.com2011-02-19 13:12:35 +0000
commite4fff6ea6e5422af23c324897ed1cff8f8a6e903 (patch)
tree030c0d0a02e25ffdef43781fbc815dbce48dd16d /docs/howto/setup.rst
parent57b3a372f2122d022f9d6f43818e5fe9d318ce03 (diff)
downloaddjango-rest-framework-e4fff6ea6e5422af23c324897ed1cff8f8a6e903.tar.bz2
Clean up the docs
Diffstat (limited to 'docs/howto/setup.rst')
-rw-r--r--docs/howto/setup.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/howto/setup.rst b/docs/howto/setup.rst
new file mode 100644
index 00000000..97b9e6d4
--- /dev/null
+++ b/docs/howto/setup.rst
@@ -0,0 +1,28 @@
+.. _setup:
+
+Setup
+=====
+
+Template Loaders
+----------------
+
+Django REST framework uses a few templates for the HTML and plain text documenting emitters.
+
+* Ensure ``TEMPLATE_LOADERS`` setting contains ``'django.template.loaders.app_directories.Loader'``.
+
+This will be the case by default so you shouldn't normally need to do anything here.
+
+Admin Styling
+-------------
+
+Django REST framework uses the admin media for styling. When running using Django's testserver this is automatically served for you, but once you move onto a production server, you'll want to make sure you serve the admin media seperatly, exactly as you would do if using the Django admin.
+
+* Ensure that the ``ADMIN_MEDIA_PREFIX`` is set appropriately and that you are serving the admin media. (Django's testserver will automatically serve the admin media for you)
+
+Markdown
+--------
+
+The Python `markdown library <http://www.freewisdom.org/projects/python-markdown/>`_ is not required but comes recommended.
+
+If markdown is installed your :class:`.Resource` descriptions can include `markdown style formatting <http://daringfireball.net/projects/markdown/syntax>`_ which will be rendered by the HTML documenting emitter.
+