Changeset 264:fbc4d5736197

Timestamp:

06/06/11 22:46:44 (12 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

Added meta-documentation

Files:

• NEWS (modified) (1 diff)
• README (modified) (3 diffs)

NEWS

@@ -17 +17 @@
 idle_check() and idle_done() methods. See the example in
 imapclient/examples/idle_example.py.
+
+Sphinx Based Docs (#5) [NEW]
+----------------------------
+Full documentation is now available under doc/html in the source
+distribution and at http://imapclient.readthedocs.org/ online.
 
 Minor Features

README

@@ -55 +55 @@
 
 
-Mailing List
-------------
-The IMAPClient mailing list can be used to ask IMAPClient related
-questions and report bugs. 
-
-* To send to the list and subscribe send an email to imapclient@librelist.com 
-* Archives of the list are available at http://librelist.com/browser/imapclient/ 
-* See http://librelist.com/help.html for more information about the mailing list
-
-
 Using IMAPClient
 ----------------
@@ -82 +72 @@
 available. See http://packages.python.org/distribute/ for more info.
 
+
+Documentation
+-------------
+HTML documentation can be found at doc/html in the source
+distribution. The documentation is also available online at:
+
+    http://imapclient.readthedocs.org/
+
+The Sphinx source is at doc/src. If Sphinx is installed, the
+documentation can be rebuilt using:
+
+    python setup.py sphinx_build
+
 See imapclient/examples/example.py for a sample of how to use
 IMAPClient. If the IMAPClient was installed from PyPI the examples
-subdirectory can be found under whereever the imapclient package is
-installed.
+subdirectory can be found under the imapclient package installation
+directory.
 
-The code is well documented. See the docstrings for more usage
-information.
+
+Mailing List
+------------
+The IMAPClient mailing list can be used to ask IMAPClient related
+questions and report bugs. 
+
+* To send to the list and subscribe send an email to imapclient@librelist.com 
+* Archives of the list are available at http://librelist.com/browser/imapclient/ 
+* See http://librelist.com/help.html for more information about the mailing list
 
 
@@ -125 +135 @@
 Unit Tests
 ----------
-There are comprehensive unit tests for the FETCH response parser and a
-growing number of other parts of the code. These tests use the
-unittest2 package which is also included as the standard unittest
-package in Python 2.7 and 3.2.
+There are comprehensive unit tests for the server response parser and
+a number of other parts of the code. These tests use the unittest2
+package which is also included as the standard unittest package in
+Python 2.7 and 3.2.
 
 Where unittest2 is included in the standard library (eg. Python 2.7