aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaul Ganssle <paul@ganssle.io>2018-05-08 11:29:50 -0400
committerPaul Ganssle <paul@ganssle.io>2018-05-08 11:47:05 -0400
commit546fbcafd332bdcc20fc10badc8b9c784fef2e49 (patch)
treeca7ca8405f247808c0d79b6d0b4b95e1a490fad6 /docs
parent6a8aded417282d0e64b544a07935d48546fadea7 (diff)
downloaddateutil-546fbcafd332bdcc20fc10badc8b9c784fef2e49.tar.gz
Restructure tz docs to be more organized
Diffstat (limited to 'docs')
-rw-r--r--docs/tz.rst42
1 files changed, 39 insertions, 3 deletions
diff --git a/docs/tz.rst b/docs/tz.rst
index 112be38..594cedb 100644
--- a/docs/tz.rst
+++ b/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: