Changeset 254:2bead8ef812d

Timestamp:

05/06/11 23:35:03 (12 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

small doc tweaks

Files:

• doc-src/conf.py (modified) (2 diffs)
• doc-src/index.rst (modified) (3 diffs)
• imapclient/__init__.py (modified) (1 diff)
• imapclient/imapclient.py (modified) (3 diffs)

doc-src/conf.py

@@ -1 +1 @@
 # -*- coding: utf-8 -*-
-#
-# IMAPClient documentation build configuration file, created by
-# sphinx-quickstart on Fri Oct  1 12:26:06 2010.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('..'))
+import sys
+from os import path
+
+sys.path.insert(0, path.abspath(path.join(path.dirname(__file__), '..')))
 
 import imapclient
@@ -44 +34 @@
 # General information about the project.
 project = u'IMAPClient'
-copyright = u'2010, Menno Smits'
+copyright = u'2011, Menno Smits'
 
 # The version info for the project you're documenting, acts as replacement for

doc-src/index.rst

@@ -6 +6 @@
 
 :Author: `Menno Smits <http://freshfoo.com>`_
-:Version: |release|
-:Date: 2011/06/05
+:Version: |version| / |release|
+:Date: |today|
 :Homepage: http://imapclient.freshfoo.com
 :Download: http://pypi.python.org/pypi/IMAPClient/
-:Documentation: http://freshfoo.com/projects/imapclient/docs/
+:Documentation: http://imapclient.readthedocs.org/
 :License: `New BSD License <http://en.wikipedia.org/wiki/BSD_licenses>`_
 :Support: `Mailing List <http://librelist.com/browser/imapclient/>`_
@@ -26 +26 @@
 
 IMAPClient is straight forward it use, but it can be useful to have at
-least a general understanding of the IMAP protocol. `RFC3501
+least a general understanding of the IMAP protocol. `RFC 3501
 <http://www.faqs.org/rfcs/rfc3501.html>`_ explains IMAP in
 detail. Other RFCs also apply to various extensions to the base
@@ -118 +118 @@
 Any method that takes a folder name will accept a standard string or a
 unicode string. Unicode strings will be transparently encoded using
-modified UTF-7 as specified by `RFC-3501 section 5.1.3
+modified UTF-7 as specified by `RFC 3501 section 5.1.3
 <http://tools.ietf.org/html/rfc3501#section-5.1.3>`_.  This allows for
 arbitrary unicode characters (eg. non-English characters) to be used

imapclient/__init__.py

@@ -3 +3 @@
 # Please see http://en.wikipedia.org/wiki/BSD_licenses
 
-__version__ = '0.8'
+__version__ = '0.8-dev'
 __author__ = 'Menno Smits <menno@freshfoo.com>'
 

imapclient/imapclient.py

@@ -168 +168 @@
         *shared*.
 
-        See `RFC-2342 <http://tools.ietf.org/html/rfc2342>`_ for more details.
+        See `RFC 2342 <http://tools.ietf.org/html/rfc2342>`_ for more details.
         """
         typ, data = self._imap.namespace()
@@ -488 +488 @@
         criteria. It defaults to US-ASCII.
 
-        See `RFC-3501 section 6.4.4 <http://tools.ietf.org/html/rfc3501#section-6.4.4>`_
+        See `RFC 3501 section 6.4.4 <http://tools.ietf.org/html/rfc3501#section-6.4.4>`_
         for more details.
         """
@@ -525 +525 @@
 
         The *criteria* argument is as per search(). 
-        See `RFC-5256 <http://tools.ietf.org/html/rfc5256>`_ for full details.
+        See `RFC 5256 <http://tools.ietf.org/html/rfc5256>`_ for full details.
 
         Note that SORT is an extension to the IMAP4 standard so it may