Merge pull request #714 from pganssle/restructure-tz-docs

Restructure tz docs

changelog.d/714.doc.rst

@@ -0,0 +1 @@
+Reorganized ``dateutil.tz`` documentation and fixed issue with the ``dateutil.tz`` docstring. (gh pr #714)

dateutil/tz/__init__.py

@@ -1,4 +1,6 @@
+# -*- coding: utf-8 -*-
 from .tz import *
+from .tz import __doc__
 
 #: Convenience constant providing a :class:`tzutc()` instance
 #:

dateutil/tz/tz.py

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 """
 This module offers timezone implementations subclassing the abstract
-:py:`datetime.tzinfo` type. There are classes to handle tzfile format files
-(usually are in :file:`/etc/localtime`, :file:`/usr/share/zoneinfo`, etc), TZ
-environment string (in all known formats), given ranges (with help from
-relative deltas), local machine timezone, fixed offset timezone, and UTC
+:py:class:`datetime.tzinfo` type. There are classes to handle tzfile format
+files (usually are in :file:`/etc/localtime`, :file:`/usr/share/zoneinfo`,
+etc), TZ environment string (in all known formats), given ranges (with help
+from relative deltas), local machine timezone, fixed offset timezone, and UTC
 timezone.
 """
 import datetime

docs/tz.rst

@@ -1,8 +1,44 @@
 ==
 tz
 ==
-.. autofunction:: dateutil.tz.gettz
+.. py:currentmodule:: dateutil.tz
 
 .. automodule:: dateutil.tz
-   :members:
-   :undoc-members:
+
+Objects
+-------
+.. py:data:: dateutil.tz.UTC
+
+    A convenience instance of :class:`dateutil.tz.tzutc`.
+
+Functions
+---------
+
+.. autofunction:: gettz
+
+    .. automethod:: gettz.nocache
+    .. automethod:: gettz.cache_clear
+
+.. autofunction:: enfold
+
+.. autofunction:: datetime_ambiguous
+.. autofunction:: datetime_exists
+
+.. autofunction:: resolve_imaginary
+
+
+Classes
+-------
+
+.. autoclass:: tzutc
+
+.. autoclass:: tzoffset
+
+.. autoclass:: tzlocal
+
+.. autoclass:: tzrange
+
+.. autoclass:: tzstr
+
+.. autoclass:: tzical
+    :members: