Some initial documentation

This commit is contained in:
David Cramer 2009-09-30 21:03:56 -05:00
parent db534b4bff
commit 5c8a9fb0e0
7 changed files with 73 additions and 7 deletions

1
.gitignore vendored
View File

@ -4,3 +4,4 @@
Coffin.egg-info
/dist
.*.swp
/docs/_build

3
docs/contrib/auth.rst Normal file
View File

@ -0,0 +1,3 @@
==========================
:mod:`coffin.contrib.auth`
==========================

20
docs/contrib/index.rst Normal file
View File

@ -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
docs/contrib/markup.rst Normal file
View File

@ -0,0 +1,3 @@
============================
:mod:`coffin.contrib.markup`
============================

View File

@ -0,0 +1,3 @@
=================================
:mod:`coffin.contrib.syndication`
=================================

View File

@ -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
==================

38
docs/install.rst Normal file
View File

@ -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`