How to install restview
- Download and install ActivePython
- Open Command Prompt
- Type
pypm install restview
Lastest release
A viewer for ReStructuredText documents that renders them on the fly.
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.
Finally, you can make sure your Python package has valid ReStructuredText in the long_description field by using
restview -e 'python setup.py --long-description' --strict
This is so useful restview has a shortcut for it
restview --long-description --strict
Synopsis
Usage: restview [options] filename-or-directory [...]
-h, --help | show this help message and exit |
-l PORT, --listen=PORT | |
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] |
-e COMMAND, --execute=COMMAND | |
run a command to produce ReStructuredText | |
--long-description | |
run "python setup.py --long-description" to produce ReStructuredText | |
--css=URL-or-FILENAME | |
use the specified stylesheet | |
--strict | halt at the slightest problem |
Changelog
2.0.1 (2013-05-01)
- Always require Pygments. Fixes https://github.com/mgedmin/restview/issues/9.
2.0 (2013-04-04)
- Python 3 support (LP#1093098). Patch by Steven Myint (git@stevenmyint.com).
- Moved to Github.
- 100% test coverage.
- Automatically reload the web page when the source file changes (LP#965746). Patch by speq (sp@bsdx.org), with modifications by Eric Knibbe and Marius Gedminas.
- New option: restview --long-description (shows the output of python setup.py --long-description).
- New option: restview --strict. Patch by Steven Myint (git@stevenmyint.com).
- Improve auto-linkification of local file names:
- allow subdirectories
- recognize .rst extensions
- Many improvements by Eric Knibbe:
- restview dirname now ignores hidden subdirectories.
- files in directory listings are sorted case-insensitively.
- allow serving gif and jpg images.
- CSS rules for rubric, sidebars, and many other things.
- syntax highlighting for code blocks.
- improved HTTP error messages.
- HTTP headers to prevent browser caching of dynamic content.
1.2.2 (2010-09-14)
- setup.py no longer requires docutils (LP#637423).
1.2.1 (2010-09-12)
- Handle spaces and other special characters in URLs (LP#616335).
- Don't linkify filenames inside external references (LP#634827).
1.2 (2010-08-06)
- "SEVERE" docutils errors now display a message and unformatted file in the browser, instead of a traceback on the console.
- New command-line option, -e COMMAND.
- Added styles for admonitions; many other important styles are still missing.
1.1.3 (2009-10-25)
- Spell 'extras_require' correctly in setup.py (LP#459840).
- Add a MANIFEST.in for complete source distributions (LP#459845).
1.1.2 (2009-10-14)
- Fix for 'localhost' name resolution error on Mac OS X.
1.1.1 (2009-07-13)
- Launches the web server in the background.
1.1.0 (2008-08-26)
- Accepts any number of files and directories on the command line.
1.0.1 (2008-07-26)
- New option: --css. Accepts a filename or a HTTP/HTTPS URL.
1.0.0 (2008-07-26)
- Bumped version number to reflect the stability.
- Minor CSS tweaks.
0.0.5 (2007-09-29)
- Create links to other local files referenced by name.
- Use pygments (if available) to syntax-highlight doctest blocks.
- Handle JPEG images.
0.0.4 (2007-09-28)
- Remove the unstable Gtk+ version.
0.0.3 (2007-09-28)
- Use setuptools for packaging.
0.0.2 (2007-01-21)
- Browser-based version.
- Command line options -l, -b (thanks to Charlie Shepherd).
- CSS tweaks.
- Unicode bugfix.
- Can browse directory trees.
- Can serve images.
0.0.1 (2005-12-06)
- PyGtk+ version with GtkMozEmbed. Not very stable.