Skip to main content

View Python package documentation

Project description

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

Installation

viewdoc requires Python 2.4 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.

Usage

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

Options

-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

The program reads style information from its configuration file ~/.viewdoc.

Changelog

1.0 - 2010-12-30

  • Initial release [stefan]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jarn.viewdoc-1.0.zip (8.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page