restview

A ReStructuredText viewer

About

A viewer for ReStructuredText documents that renders them on the fly.

screenshot of restview

Pass the name of a ReStructuredText document to restview, and it will launch a web server on localhost:random-port and open a web browser. Every time you reload the page, restview will reload the document from disk and render it. This is very convenient for previewing a document while you're editing it.

You can also pass the name of a directory, and restview will recursively look for files that end in .txt or .rst and present you with a list.

Usage

$ restview [options] /path/to/filename.txt

restview can also serve a listing of all txt and rst files in a directory tree.

$ restview [options] /path/to/directory

Options:

  -l LISTEN, --listen=LISTEN
                        listen on a given port (or interface:port, e.g.
                        *:8080) [default: random port on localhost]
  -b, --browser         open a web browser [default: only if -l was not
                        specified]

Download

restview is available from Cheeseshop: http://pypi.python.org/pypi/restview. You can also easy_install it.

You will need docutils and, optionally, pygments.

You can check out the latest version from my Bazaar repository:

bzr branch lp:restview

Or you can browse the repository with a Web browser.

Authors and Licencing

restview was written by Marius Gedminas. It is released under the terms of the GNU GPL.

Please report bugs in Launchpad.