1 .. -*- restructuredtext -*-

     2 

     3 =================

     4 README for sphinx-simplecomment

     5 =================

     6 

     7 The Project

     8 ===========

     9 

    10 The project is inspired by django book and hg book. It allows us 

    11 to comment on sphinx documentation. It basically contains a builder

    12 file called simplecomment.py. This script creates id tags on all paragraphs 

    13 of all html output. The javascipt file simplecomment.js and sphinx_django 

    14 app are used to track all the comments and DOM-manipulation.

    15 

    16 

    17 Installing

    18 ==========

    19 The installation procedure is supposed to be something like ::

    20 

    21 sphinx-quickstart

    22 make simplecomment

    23 

    24 Copy the paragraph_id.py file created in project/_build/commenthtml/ to sphinx_django app .

    25 Also copy the simplecomment.js javascript file to project/_build/commenthtml/_static/

    26 

    27 Change the urls.py to point to the whereever your commenthtml/ directory is .

    28 

    29 

    30 This should be it.

    31 

    32 The most important TO-DO is to smoothen all these processes.

    33 

    34 

    35