# HG changeset patch
# User amit
# Date 1287139460 -19800
# Node ID 980530aeb5609dc4bf085ed5f94cab60ab6cf51e

First Commit of Commenting system for sphinx

diff -r 000000000000 -r 980530aeb560 README
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Fri Oct 15 16:14:20 2010 +0530
@@ -0,0 +1,35 @@
+.. -*- restructuredtext -*-
+
+=================
+README for sphinx-simplecomment
+=================
+
+The Project
+===========
+
+The project is inspired by django book and hg book. It allows us 
+to comment on sphinx documentation. It basically contains a builder
+file called simplecomment.py. This script creates id tags on all paragraphs 
+of all html output. The javascipt file simplecomment.js and sphinx_django 
+app are used to track all the comments and DOM-manipulation.
+
+
+Installing
+==========
+The installation procedure is supposed to be something like ::
+
+sphinx-quickstart
+make simplecomment
+
+Copy the paragraph_id.py file created in project/_build/commenthtml/ to sphinx_django app .
+Also copy the simplecomment.js javascript file to project/_build/commenthtml/_static/
+
+Change the urls.py to point to the whereever your commenthtml/ directory is .
+
+
+This should be it.
+
+The most important TO-DO is to smoothen all these processes.
+
+
+
diff -r 000000000000 -r 980530aeb560 sphinx_django
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sphinx_django	Fri Oct 15 16:14:20 2010 +0530
@@ -0,0 +1,1 @@
+/home/amit/repos/sphinx_django/sphinx_django/
\ No newline at end of file