Commits

Daniel Greenfeld committed ad35210

Add visitor utils reference

Comments (0)

Files changed (4)

 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
+
+import settings
+from django.core.management import setup_environ
+setup_environ(settings)
 
 # -- General configuration -----------------------------------------------------
 
     python manage.py syncdb
 
 Custom Settings
-------------
+---------------
+
 Add the following two properties to your settings file::
 
     COOKIE_DOMAIN
         Default = 31536000 # or 1 year.
         # This is how long the cookie will live in your visitors browser before it expires on it's own
         COOKIE_MAX_AGE = 31536000 # 1 year
+        
+References
+----------
+        
+.. toctree::
+    :maxdepth: 2
+
+    ref_visitor_utils
 
 
 Indices and tables

docs/ref_visitor_utils.rst

+=======================
+Visitor Utils Reference
+=======================
+
+
+.. automodule:: visitor.visitor_utils
+  :members:
+  :undoc-members:

visitor/visitor_utils.py

+import itertools
+import time
 import uuid
-import time
-import itertools
+
+from django.conf import settings
 
 from visitor.models import Visitor
 from visitor import visitor_constants as constants
-from django.conf import settings
 
 # this is a counter to make sure our uuid's are unique.
 counter = itertools.count(0).next
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.