diff --git a/changelog.d/714.doc.rst b/changelog.d/714.doc.rst new file mode 100644 index 0000000000000000000000000000000000000000..13a32f627aa4c769f4564a4ceba0dd3c7ab8c879_Y2hhbmdlbG9nLmQvNzE0LmRvYy5yc3Q= --- /dev/null +++ b/changelog.d/714.doc.rst @@ -0,0 +1,1 @@ +Reorganized ``dateutil.tz`` documentation and fixed issue with the ``dateutil.tz`` docstring. (gh pr #714) diff --git a/dateutil/tz/__init__.py b/dateutil/tz/__init__.py index 0219cc3c8a3142ae26a6a3abb0cb5755039b0756_ZGF0ZXV0aWwvdHovX19pbml0X18ucHk=..13a32f627aa4c769f4564a4ceba0dd3c7ab8c879_ZGF0ZXV0aWwvdHovX19pbml0X18ucHk= 100644 --- a/dateutil/tz/__init__.py +++ b/dateutil/tz/__init__.py @@ -1,1 +1,2 @@ +# -*- coding: utf-8 -*- from .tz import * @@ -1,4 +2,5 @@ from .tz import * +from .tz import __doc__ #: Convenience constant providing a :class:`tzutc()` instance #: diff --git a/dateutil/tz/tz.py b/dateutil/tz/tz.py index 0219cc3c8a3142ae26a6a3abb0cb5755039b0756_ZGF0ZXV0aWwvdHovdHoucHk=..13a32f627aa4c769f4564a4ceba0dd3c7ab8c879_ZGF0ZXV0aWwvdHovdHoucHk= 100644 --- a/dateutil/tz/tz.py +++ b/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 diff --git a/docs/tz.rst b/docs/tz.rst index 0219cc3c8a3142ae26a6a3abb0cb5755039b0756_ZG9jcy90ei5yc3Q=..13a32f627aa4c769f4564a4ceba0dd3c7ab8c879_ZG9jcy90ei5yc3Q= 100644 --- a/docs/tz.rst +++ b/docs/tz.rst @@ -1,6 +1,6 @@ == tz == -.. autofunction:: dateutil.tz.gettz +.. py:currentmodule:: dateutil.tz .. automodule:: dateutil.tz @@ -5,4 +5,40 @@ .. 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: