Changeset 264:fbc4d5736197 for README

Show
Ignore:
Timestamp:
06/06/11 22:46:44 (12 months ago)
Author:
Menno Smits <menno@…>
Branch:
default
Message:

Added meta-documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • README

    r197 r264  
    5555 
    5656 
    57 Mailing List 
    58 ------------ 
    59 The IMAPClient mailing list can be used to ask IMAPClient related 
    60 questions and report bugs.  
    61  
    62 * To send to the list and subscribe send an email to imapclient@librelist.com  
    63 * Archives of the list are available at http://librelist.com/browser/imapclient/  
    64 * See http://librelist.com/help.html for more information about the mailing list 
    65  
    66  
    6757Using IMAPClient 
    6858---------------- 
    … …  
    8272available. See http://packages.python.org/distribute/ for more info. 
    8373 
     74 
     75Documentation 
     76------------- 
     77HTML documentation can be found at doc/html in the source 
     78distribution. The documentation is also available online at: 
     79 
     80    http://imapclient.readthedocs.org/ 
     81 
     82The Sphinx source is at doc/src. If Sphinx is installed, the 
     83documentation can be rebuilt using: 
     84 
     85    python setup.py sphinx_build 
     86 
    8487See imapclient/examples/example.py for a sample of how to use 
    8588IMAPClient. If the IMAPClient was installed from PyPI the examples 
    86 subdirectory can be found under whereever the imapclient package is 
    87 installed. 
     89subdirectory can be found under the imapclient package installation 
     90directory. 
    8891 
    89 The code is well documented. See the docstrings for more usage 
    90 information. 
     92 
     93Mailing List 
     94------------ 
     95The IMAPClient mailing list can be used to ask IMAPClient related 
     96questions and report bugs.  
     97 
     98* To send to the list and subscribe send an email to imapclient@librelist.com  
     99* Archives of the list are available at http://librelist.com/browser/imapclient/  
     100* See http://librelist.com/help.html for more information about the mailing list 
    91101 
    92102 
    … …  
    125135Unit Tests 
    126136---------- 
    127 There are comprehensive unit tests for the FETCH response parser and a 
    128 growing number of other parts of the code. These tests use the 
    129 unittest2 package which is also included as the standard unittest 
    130 package in Python 2.7 and 3.2. 
     137There are comprehensive unit tests for the server response parser and 
     138a number of other parts of the code. These tests use the unittest2 
     139package which is also included as the standard unittest package in 
     140Python 2.7 and 3.2. 
    131141 
    132142Where unittest2 is included in the standard library (eg. Python 2.7