skip to navigation
skip to content

jarn.viewdoc 2.1

Python documentation viewer

viewdoc is a Python package documentation viewer. It converts reST-formatted text to HTML and displays it in a browser window.

viewdoc is typically used to check a package’s long description before uploading it to PyPI.


viewdoc works with Python 2.6 - 3.6 and all released versions of setuptools and distribute.

Use pip install jarn.viewdoc to install the viewdoc script.


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


-s style, --style=style, or --style
Select the custom style added to the HTML output.
-b browser, --browser=browser
Select the browser used for display. For a list of names see the webbrowser module.
-c config-file, --config-file=config-file
Use config-file instead of the default ~/.viewdoc.
-l, --list-styles
List available styles and exit.
-h, --help
Print the help message and exit.
-v, --version
Print the version string and exit.
The reST file to view.
The Python package whose long description to view. Defaults to the current working directory.


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

Known Bugs

If you are on macOS Sierra be aware of As a workaround specify the browser on the command line:

$ viewdoc -b safari src/my.package

or use the configuration file:

browser = safari


2.1 - 2017-10-06

  • Add [stefan]

2.0 - 2017-07-20

  • Update pypi stylesheet (grey code blocks). [stefan]
  • Automatically upgrade stylesheet information. [stefan]
  • Add -b option to specify the browser to use. [stefan]
  • Protect against bad or incomplete locale settings. [stefan]

1.8 - 2017-01-30

  • Support Python 2.6 - 3.6 without 2to3. [stefan]

1.7 - 2014-03-22

  • Update PyPI stylesheet links in the face of new [stefan]
  • Add new pypi style and rename previous one to classic. [stefan]

1.6 - 2013-11-21

  • Support Python 3.x. [stefan]

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]
File Type Py Version Uploaded on Size
jarn.viewdoc-2.1-py2.py3-none-any.whl (md5) Python Wheel 3.6 2017-10-06 14KB (md5) Source 2017-10-06 18KB