.. -*- 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.