diff --git a/.gitignore b/.gitignore index b7ab63b..fcf0c4b 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ Coffin.egg-info /dist .*.swp +/docs/_build \ No newline at end of file diff --git a/docs/contrib/auth.rst b/docs/contrib/auth.rst new file mode 100644 index 0000000..704cf52 --- /dev/null +++ b/docs/contrib/auth.rst @@ -0,0 +1,3 @@ +========================== +:mod:`coffin.contrib.auth` +========================== diff --git a/docs/contrib/index.rst b/docs/contrib/index.rst new file mode 100644 index 0000000..afcb47f --- /dev/null +++ b/docs/contrib/index.rst @@ -0,0 +1,20 @@ +===================== +:mod:`coffin.contrib` +===================== + +Coffin includes replacements for several Django contrib modules. + +To use this, simply change your import line from:: + + from django.contrib. + +To:: + + from coffin.contrib. + +.. toctree:: + :maxdepth: 2 + + auth + markup + syndication diff --git a/docs/contrib/markup.rst b/docs/contrib/markup.rst new file mode 100644 index 0000000..e823339 --- /dev/null +++ b/docs/contrib/markup.rst @@ -0,0 +1,3 @@ +============================ +:mod:`coffin.contrib.markup` +============================ diff --git a/docs/contrib/syndication.rst b/docs/contrib/syndication.rst new file mode 100644 index 0000000..94c34e5 --- /dev/null +++ b/docs/contrib/syndication.rst @@ -0,0 +1,3 @@ +================================= +:mod:`coffin.contrib.syndication` +================================= diff --git a/docs/index.rst b/docs/index.rst index 3ca48ab..214c010 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,14 @@ -.. Coffin documentation master file, created by - sphinx-quickstart on Tue Sep 8 15:22:15 2009. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Coffin's documentation! -================================== +Coffin Documentation +==================== Contents: .. toctree:: :maxdepth: 2 + install + contrib/index + Indices and tables ================== diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..fbd658c --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,38 @@ +Installation +============ + +Install the package through PyPi:: + + easy_install Coffin + +Or alternatively, get the source:: + + git clone git://github.com/dcramer/coffin.git + cd coffin + python setup.py install + +Once installed, you will need to add Coffin to several places throughout your projects. + +First, open up ``settings.py`` and add Coffin to your ``INSTALLED_APPS``:: + + INSTALLED_APPS = ( + 'coffin', + ... + ) + +The easiest way to enable Jinja2, rather than Django, is to change your import paths. For example, if we're using the ``render_to_response`` shortcut, we simply need to tweak our import line:: + + from django.shortcuts import render_to_response + +To the following:: + + from coffin.shortcuts import render_to_response + +Coffin includes drop in replacements for the following Django modules: + +* :mod:`django.shortcuts` +* :mod:`django.views.generic.simple` +* :mod:`django.contrib.auth` +* :mod:`django.contrib.markup` +* :mod:`django.contrib.syndication` +* :mod:`django.template` \ No newline at end of file