sandbox/rstdiff/README.txt

   1 ==============
   2 rstdiff README
   3 ==============
   4
   5 Overview
   6 ========
   7
   8 `rstdiff.py` takes two reStructuredText documents as input, does a
   9 structural comaprison on them and produces an annotated result
  10 highlighting the changes. `rstdiff.py` "understands" reStructuredText
  11 and therefore is able to care for the subtleties of such a comparison
  12 the result is usually much more useful than a plain source diff.
  13
  14 The result is then written by a Docutils writer. Use the `--writer`
  15 option to select a writer for the result.
  16
  17 Installation
  18 ============
  19
  20 `rstdiff.py` uses the standard Distutils package. Thus the
  21 installation is done with something like::
  22
  23   python setup.py install