Author: brosner
Date: Mon Sep 22 11:00:52 2008
New Revision: 928
Modified:
trunk/docs/deployment.txt
trunk/docs/install.txt
Log:
Cleaned up the documentation a bit.
Modified: trunk/docs/deployment.txt
==============================================================================
--- trunk/docs/deployment.txt (original)
+++ trunk/docs/deployment.txt Mon Sep 22 11:00:52 2008
@@ -1,12 +1,16 @@
+.. _ref-deployment:
+
Deployment
==========
In short:
-- create a ``localsettings.py`` alongside ``settings.py`` for your
host-specific settings (like database connection, email, etc)
-- if you are using WSGI, create a ``.wsgi`` file that does the necessary
path manipulation
+- Create a ``localsettings.py`` alongside ``settings.py`` for your
+ host-specific settings (like database connection, email, etc).
+- If you are using WSGI, create a ``.wsgi`` file that does the necessary
+ path manipulation.
- mod_python instructions coming...
-- set up ``cron`` job for mailer and asynchronous notifications
+- Set up ``cron`` job for mailer and asynchronous notifications.
Sample WSGI File
----------------
@@ -19,7 +23,8 @@
from os.path import abspath, dirname, join
from site import addsitedir
path =
addsitedir(abspath(join(dirname(__file__), 'django-hotclub', 'external_libs')),
set())
- if path: sys.path = list(path) + sys.path
+ if path:
+ sys.path = list(path) + sys.path
sys.path.insert(0,
abspath(join(dirname(__file__), 'django-hotclub', 'external_apps')))
sys.path.insert(0,
abspath(join(dirname(__file__), 'django-hotclub', 'local_apps')))
@@ -35,9 +40,8 @@
Sample cronjob
--------------
-See documentation for django-mailer and django-notification for more
information on this:
-
-::
+See documentation for django-mailer and django-notification for more
+information on this::
* * * * * (cd /path/to/pinax; /usr/local/bin/python2.5 manage.py
send_mail >> /path/to/pinax/cron_mail.log 2>&1)
* * * * * (cd /path/to/pinax ; /usr/local/bin/python2.5 manage.py
emit_notices >> /path/to/pinax/emit_notices.log 2>&1)
Modified: trunk/docs/install.txt
==============================================================================
--- trunk/docs/install.txt (original)
+++ trunk/docs/install.txt Mon Sep 22 11:00:52 2008
@@ -1,19 +1,25 @@
Installation
============
-Pinax has not yet had its first formal release so the code is only
available via Subversion:
+Pinax has not yet had its first formal release so the code is only
available
+via Subversion::
svn checkout http://django-hotclub.googlecode.com/svn/trunk/
django-hotclub
-(The term *django-hotclub* refers to the reusable Django app project that
spawned Pinax.)
+(The term *django-hotclub* refers to the reusable Django app project that
+spawned Pinax.)
-Pinax takes a batteries-included approach so that checkout (which includes
a lot of svn:externals for third-party apps and libraries used) will almost
work out of the box. The one exception is the `Python Imaging Library`
(PIL) which you will have to provide yourself if you want photo support.
+Pinax takes a batteries-included approach so that checkout (which includes
+a lot of svn:externals for third-party apps and libraries used) will almost
+work out of the box. The one exception is the `Python Imaging Library`
(PIL)
+which you will have to provide yourself if you want photo support.
Note that if you already have an external app or external library on the
path,
you don't need to use the one we provide.
-Once the checkout is complete, you should be able to cd into pinax/ and
run ./manage.py syncdb and ./manage.py runserver to get
-running immediately.
+Once the checkout is complete, you should be able to cd into pinax/ and run
+``./manage.py syncdb`` and ``./manage.py runserver`` to get running
+immediately.
Directory Structure
-------------------
@@ -32,7 +38,8 @@
There is some path manipulation in manage.py to get this all to work.
You'll
-need to do something similar in your wsgi or mod_python configuration. See
`Deployment` for more details.
+need to do something similar in your wsgi or mod_python configuration. See
+:ref:`ref-deployment` for more details.
See also
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
