Commits

gmh04  committed 3781c25

create rst documentation

  • Participants
  • Parent commits 1592db2

Comments (0)

Files changed (3)

+===================
+cmslplugin-comments
+===================
+
+A django-cms plugin for adding comments
+
+Dependencies
+------------
+* captcha
+
+Installation
+------------
+
+::
+
+    pip install cmsplugin-comments
+
+settings.py::
+
+    INSTALLED_APPS = (
+        ...
+        'cmsplugin_comments',
+        ...
+    )
+
+urls.py::
+
+    urlpatterns = patterns('',
+        ...
+        url(r'^comments/', include('django.contrib.comments.urls')),
+        ...
+    )
+
+Enable captcha
+--------------
+
+settings.py::
+
+    INSTALLED_APPS = (
+        ...
+        'cmsplugin_comments',
+        ...
+    )
+
+    COMMENTS_APP = 'cmsplugin_comments'
+
+urls.py::
+
+     urlpatterns = patterns('',
+        ...
+        url(r'^comments/', include('captcha.urls')),
+        ...
+    )
+
+
+Enable emailing of new messages to admins
+-----------------------------------------
+
+settings.py::
+
+    EMAIL_HOST=
+    EMAIL_PORT=
+    EMAIL_HOST_USER='my@email.com'
+    EMAIL_HOST_PASSWORD='xxx'
+    EMAIL_USE_TLS=True
+
+
+    touch {project-home}/templates/comments/comment_notification_email.txt
+
+finally::
+
+    manage.py syncdb
+    manage.py migrate
-To install cmsplugin-comments
+Dependencies
+------------
 
-pip install cmsplugin-comments
+Installation::
+
+   pip install cmsplugin-comments
+
+
+settings.py::
+
+    INSTALLED_APPS = (
+        ...
+        'cmsplugin_comments',
+        ...
+    )
 
 Add url(r'^comments/', include('django.contrib.comments.urls')), to urls.py
 Add 'cmsplugin_comments' to INSTALLED_APPS
 Add 'capcha' to INSTALLED_APPS
 Add COMMENTS_APP = 'cmsplugin_comments' to settings
 
-To Enable emailing of new messages to admins add the following to settings
+To Enable emailing of new messages to admins add the following to settings::
 
 EMAIL_HOST=
 EMAIL_PORT=
 
 Add a comment_notification_email.txt template to {project-home}/templates/comments
 
-finally:
+finally::
 
 manage.py syncdb
 manage.py migrate
     name='cmsplugin-comments',
     version= '0.1',
     description='A very simple plugin for django-cms 2 to implement comments',
-    long_description=open('README.txt').read(),
+    long_description=open('README.rst').read(),
     #author='',
     #author_email='X',
     maintainer='gmh04',