jarn.viewdoc 1.5

Python documentation viewer

viewdoc is a Python package documentation viewer. It converts reST-formatted text to HTML and displays it in a browser window. It is typically used to check a package’s long description before uploading it to PyPI.

Also see jarn.mkrelease.

Installation

viewdoc requires Python 2.5 or higher. Use easy_install jarn.viewdoc to install the viewdoc script. Then put it on your system PATH by e.g. symlinking it to /usr/local/bin.

Upgrade Note: If you have jarn.viewdoc < 1.3 installed, move away your existing ~/.viewdoc file to get the updated styles.

Usage

viewdoc [options] [rst-file|egg-dir]

Options

-s style, --style=style, or --style

Select the custom style added to the HTML output. Used to override the configuration file setting of the same name.

-l, --list-styles

List available styles and exit.

-h, --help

Print the help message and exit.

-v, --version

Print the version string and exit.

rst-file

The reST file to view.

egg-dir

The Python package whose long description to view. Defaults to the current working directory.

Configuration

viewdoc reads style information from its configuration file ~/.viewdoc. Edit this file to add your own styles.

Changelog

1.5 - 2012-07-11

• Restore Python 2.5 compatibility. [stefan]

1.4 - 2011-11-25

• Warn if ~/.viewdoc has errors instead of raising an exception. [stefan]

1.3 - 2011-10-31

• Be more careful with what we put on the PYTHONPATH. [stefan]

• Add small style to the default config. [stefan]

1.2 - 2011-07-19

• Pass the PYTHONPATH to subprocesses. [stefan]

• Avoid temp file when extracting the long description. [stefan]

• Add -l option to list available styles. [stefan]

• Add –style shortcut for -s style. [stefan]

1.1 - 2011-02-08

• Add -s option to select styles on the command line. [stefan]

• In pypi style, only underline reference links. [stefan]

1.0 - 2010-12-30

• Initial release [stefan]