Commits

Michael Godshall  committed 298a29b

Updated documenation and comments

  • Participants
  • Parent commits 97abb9a

Comments (0)

Files changed (7)

-Documentation is available in Sphinx format in the docs folder.
+Documentation is available in the docs folder.
 
 For installation instructions see docs/install.rst.

File docs/install.rst

 Creating the Virtual Environment
 ================================
 
+First, make sure you install virtualenv:
+
+    easy_install virtualenv
+
 First, create a clean base environment using virtualenvwrapper::
 
     mkvirtualenv rustynail --no-site-packages

File docs/profiles.rst

+User Profiles
+==========
+
+Views and urls for user profiles are handled by the django-profiles app.
+Documentation for this app is located at https://bitbucket.org/ubernostrum/django-profiles/src/tip/docs/
+
+See the "accounts" app (/apps/accounts/) for custom profile forms and models.

File docs/registration.rst

+User Registration
+==========
+
+User registration is handled by the django-registration app.
+Documentation for this app is located at https://bitbucket.org/ubernostrum/django-registration/src/tip/docs/

File rustynail/apps/accounts/models.py

     """
     User Profile model for storing extra account info and preferences.
 
-    See 
+    Set AUTH_PROFILE_MODULE in settings.py to:
+
+        AUTH_PROFILE_MODULE = "accounts.UserProfile"
+
+    To access a user's profile, use the get_profile() method:
+
+        user.get_profile()
     """
     user = models.OneToOneField(User)
 

File rustynail/local_settings.txt

+"""
+Customize settings that are unique to your local environment.
+Universal settings should be added to settings.py.
+"""
 import os
 
 PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))

File rustynail/urls.py

 from registration.views import register
 
 urlpatterns = patterns('',
+    # home page
     url(r'^$', TemplateView.as_view(template_name="home.html"), name="home"),
+    # django-registration url override
     (r'^accounts/register/', register, {'backend': 'registration.backends.simple.SimpleBackend',
                                         'form_class': RegistrationFormUniqueEmail,}),
+    # django-registration urls
     (r'^accounts/', include('registration.backends.simple.urls')),
+    # django-profiles url override
     (r'^profiles/edit/', 'profiles.views.edit_profile', {'form_class': UserProfileForm,}),
+    # django-profiles urls
     (r'^profiles/', include('profiles.urls')),
+    # admin urls
     (r'^admin/', include(admin.site.urls)),
 )