public
Description: Documentation about how to write and maintain a Django reusable app.
Homepage: http://appdocs.oebfare.com/
Clone URL: git://github.com/brosner/django-reusable-app-docs.git
name age message
file Makefile Sun Dec 28 22:51:33 -0800 2008 Added the result of sphinx-quickstart. [brosner]
file README Sun Dec 28 23:36:12 -0800 2008 Tests is an important part of good reusable app. [brosner]
file conf.py Sun Dec 28 23:43:08 -0800 2008 Updated the version. [brosner]
file index.txt Sun Dec 28 23:42:00 -0800 2008 Changed main header of index.txt. [brosner]
file update_docs.sh Mon Dec 29 11:23:52 -0800 2008 Added a quick script to update the documentatio... [brosner]
README
This project is meant to hold documentation on how to build and maintain
Django reusable apps. This document is going to serve (for now) as the place
of my current ideas.

One item on the Pinax TODO/wish list is to have good documentation about all
aspects of a Django resuable app. This includes, but not limited to:

 * how to write one
 * how to release one
 * best practices

The documentation should be clear and structured logically like the Django
documentation itself. This documentation should cover:

 * admin
 * internationalization
 * models
 * feeds (if applicable)
 * templates
 * templatetags
 * documentation
 * distribution
 * generic views
 * urls
 * tests

I really encourage anyone to fork this project and start contributing patches
back to me. I can certainly envision there will need to a lot of dicussion
about how things should be. Lets get it started again.

James Tauber started a mailing list and freenode IRC channel for this exact
stuff. django-hotclub [1] and #django-hotclub [2] respectively.

Also, I have setup a hosted location for the documentation [3]. This is
automatically updated from the master branch every ten minutes.

[1]: http://groups.google.com/group/django-hotclub
[2]: irc://irc.freenode.net/django-hotclub
[3]: http://appdocs.oebfare.com