Metadata-Version: 1.1
Name: collective.checkdocs
Version: 0.2
Summary: Distutils command to view and validate restructured text in package's long_description
Home-page: http://pypi.python.org/pypi/collective.checkdocs
Author: mFabrik Research Oy
Author-email: info@mfabrik.com
License: GPL
Description: collective.checkdocs adds new distutils commands ``checkdocs`` and ``showdocs`` to validate restructured text in long_description field of Python eggs. 
        This package aims to make Python egg help page publishing and editing easier.
        
        Eggs' long description field, which is usually also the README.txt file of the package, is reST formatted text. This text is converted
        to HTML to show on the package page when package is published in distribution repositories like PyPI or plone.org.
        Unfortunately, since repositories do poor job to validate incoming reST text, errors in the text will result to broken published
        package pages. 
        
        Unpublishing is usually very cumbersome. 
        We save our time by validating reST input using ``checkdocs`` and ``showdocs`` commands
        before submitting eggs to PyPi.
        
        Installation
        ============
        
        Install this to your development Python run-time::
        
                easy_install collective.checkdocs
        
        
        *Note*: On OSX at least Python version 2.5 or newer is required.
                
        New commands
        ============
        
        The following commands will be added to all setup.py installers.
        
        checkdocs
        ---------
        
        Run long_description through reST to HTML converter and print errors and warnings to the standard output.
        
        Any errors or warnings will cause distutils to abort.
        
        Example::
        
          python setup.py checkdocs
          <string>:4: (WARNING/2) Inline literal start-string without end-string.
          error: long_description had reST syntax errors
        
        showdocs
        ---------
        
        Run long_description through reST to HTML converter and display the result in a local web browser. Runs a web server in port 6969 until CTRL+C is pressed.
        
        Example::
        
          python setup.py showdocs
          running showdocs
          reST to HTML conversion available at at http://localhost:6969/ - press CTRL+C to interrupt
        
        Source code
        ------------
        
        * https://svn.plone.org/svn/collective/collective.checkdocs
        
        Authors
        -------
        
        `Mikko Ohtamaa <https://opensourcehacker.com>`_ 
        
        Resources
        ---------
        
        * long_description text is `restructured formatted <http://docutils.sourceforge.net/rst.html>`_
        
        * `docutils <http://docutils.sourceforge.net/>`_
        
        * `rstctl (inspiration and sources) <http://pypi.python.org/pypi/rstctl>`_
        
        * `How it all begun <http://www.nabble.com/Checking-long_description-format-(reST)-before-it-is-sent-to-PyPI-td15613184.html>`_
        
Keywords: rest distutils egg validator check validation restructured text html documentation
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Python Modules
