Skip to content

Commit

Permalink
Some initial documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
David Cramer authored and David Cramer committed Oct 1, 2009
1 parent db534b4 commit 5c8a9fb
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
Coffin.egg-info
/dist
.*.swp
/docs/_build
3 changes: 3 additions & 0 deletions docs/contrib/auth.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
==========================
:mod:`coffin.contrib.auth`
==========================
20 changes: 20 additions & 0 deletions docs/contrib/index.rst
Original file line number Diff line number Diff line change
@@ -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.<module>

To::

from coffin.contrib.<module>

.. toctree::
:maxdepth: 2

auth
markup
syndication
3 changes: 3 additions & 0 deletions docs/contrib/markup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
============================
:mod:`coffin.contrib.markup`
============================
3 changes: 3 additions & 0 deletions docs/contrib/syndication.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
=================================
:mod:`coffin.contrib.syndication`
=================================
12 changes: 5 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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
==================

Expand Down
38 changes: 38 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -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`

0 comments on commit 5c8a9fb

Please sign in to comment.