sandbox/agurtovoy/html_frames/README.txt

   1
   2 Docutils HTML/frames writer
   3 ***************************
   4
   5 This is an implementation of Docutils__ writer that produces "framed"
   6 or "chunked" HTML documents. Please see `Docutils Sandbox
   7 repository`__ for the latest and greatest version.
   8
   9 Note that the writer requires your reStructuredText__ documents to contain
  10 the `contents directive`__ that instructs the docutils front-end to
  11 generate a table of contents used by the writer to determine how to split
  12 the document.
  13
  14 After the writer is installed (``python setup.py install``), its typical
  15 invocation looks like this::
  16
  17     rst2htmlframes.py README.txt README.html
  18
  19 Examples of writer's output are available at http://www.mywikinet.com/docutils/
  20 and http://boost.org/libs/mpl/doc/.
  21
  22 Known issues:
  23
  24   - ``--no-doc-title`` option is not supported
  25
  26 Author: `Aleksey Gurtovoy`__
  27
  28
  29 __ http://docutils.sourceforge.net/
  30 __ http://docutils.sourceforge.net/sandbox/README.html
  31 __ http://docutils.sourceforge.net/rst.html
  32 __ http://docutils.sourceforge.net/spec/rst/directives.html#table-of-contents
  33 __ mailto:agurtovoy@meta-comm.com