Revision: 119 Author: [email protected] Date: Wed Oct 14 03:45:13 2009 Log: updating docs http://code.google.com/p/django-messages/source/detail?r=119
Added: /trunk/docs/README.txt /trunk/docs/django-messages.png Modified: /trunk/docs/conf.py /trunk/docs/index.txt /trunk/docs/usage.txt ======================================= --- /dev/null +++ /trunk/docs/README.txt Wed Oct 14 03:45:13 2009 @@ -0,0 +1,5 @@ +run + +sphinx-build . build/ + +to build the documentation into the a directory named ./build/ ======================================= --- /dev/null +++ /trunk/docs/django-messages.png Wed Oct 14 03:45:13 2009 Binary file, no diff available. ======================================= --- /trunk/docs/conf.py Wed May 6 03:23:40 2009 +++ /trunk/docs/conf.py Wed Oct 14 03:45:13 2009 @@ -51,7 +51,7 @@ # The short X.Y version. version = '0.4' # The full version, including alpha/beta/rc tags. -release = '0.4pre' +release = '0.4.3pre' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -64,7 +64,7 @@ #today_fmt = '%B %d, %Y' # List of documents that shouldn't be included in the build. -#unused_docs = [] +unused_docs = ['README',] # List of directories, relative to source directory, that shouldn't be searched # for source files. @@ -91,6 +91,8 @@ # Options for HTML output # ----------------------- +html_theme_path = ['.',] + # The style sheet to use for HTML and HTML Help pages. A file of that name # must exist either in Sphinx' static/ path, or in one of the custom paths # given in html_static_path. @@ -105,7 +107,7 @@ # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +html_logo = './django-messages.png' # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 ======================================= --- /trunk/docs/index.txt Tue Jul 7 06:45:29 2009 +++ /trunk/docs/index.txt Wed Oct 14 03:45:13 2009 @@ -2,13 +2,12 @@ django-messages =============== -``messages`` is a Django app which provides a user-to-user messaging system. -Django-messages enables your users to send private messages to each other. It -provides a basic set of functionality you would expect from such a system. -Every user has an inbox, an Outbox and a Trash. Messages can be composed and -there is an easy url-based approach to preloading the compose-form with the -recipient user, which makes it extremly easy to put "send xyz a message" links -on profile pages. +Django-messages is a Django app which provides a user-to-user messaging system. +It enables your users to send private messages to each other. It provides a +basic set of functionality you would expect from such a system. Every user +has an inbox, an Outbox and a Trash. Messages can be composed and there is an +easy url-based approach to preloading the compose-form with the recipient user, +which makes it extremly easy to put "send user a message" links on profile pages. Currently django-messages comes with these translations: @@ -18,8 +17,14 @@ * pl * es * pt_BR -* ru_RU +* ru * nl +* da +* el +* zh_CN + +Contents +-------- .. toctree:: ======================================= --- /trunk/docs/usage.txt Mon Oct 12 05:37:43 2009 +++ /trunk/docs/usage.txt Wed Oct 14 03:45:13 2009 @@ -74,10 +74,10 @@ instead of loading the Templatetag. Simply add the Context Processor to the TEMPLATE_CONTEXT_PROCESSORS settings in your settings.py:: -TEMPLATE_CONTEXT_PROCESSORS = ( - ... - 'messages.context_processors.inbox', -) + TEMPLATE_CONTEXT_PROCESSORS = ( + ... + 'messages.context_processors.inbox', + ) And now every Template Context will contain a variable named ``messages_inbox_count``, if the user is logged in:: --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "pinax-updates" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/pinax-updates?hl=en -~----------~----~----~----~------~----~------~--~---
