Metadata-Version: 1.0
Name: jarn.viewdoc
Version: 1.0
Summary: View Python package documentation
Home-page: http://www.jarn.com/
Author: Jarn AS
Author-email: info@jarn.com
License: BSD
Description: ============
        jarn.viewdoc
        ============
        ---------------------------------
        View Python package documentation
        ---------------------------------
        
        **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]
        
        
Keywords: view rest docs
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
