Updated docs.

Author: domdfcoding

.isort.cfg

@@ -22,6 +22,7 @@ known_third_party =
     github
     importlib-metadata
     importlib-resources
+    packaging
     pandas
     pydash
     pytest

doc-source/api/dates.rst

@@ -2,14 +2,6 @@
 :mod:`domdf_python_tools.dates`
 =================================
 
-.. extras-require:: dates
-
-	pytz >=2019.1
-
-
-.. warning:: This module has not been fully tested. Use with caution.
-
-
 .. automodule:: domdf_python_tools.dates
 	:undoc-members:
 	:exclude-members: months

doc-source/api/iterative.rst

@@ -1,5 +1,5 @@
-=================================
+====================================
 :mod:`domdf_python_tools.iterative`
-=================================
+====================================
 
 .. automodule:: domdf_python_tools.iterative

doc-source/conf.py

@@ -71,6 +71,7 @@
 		'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
 		'pandas': ('https://pandas.pydata.org/docs/', None),
 		'consolekit': ('https://consolekit.readthedocs.io/en/latest/', None),
+		'pytest': ('https://docs.pytest.org/en/stable', None),
 		}
 
 html_theme = 'domdf_sphinx_theme'

domdf_python_tools/dates.py

@@ -3,6 +3,14 @@
 #  dates.py
 """
 Utilities for working with dates and times.
+
+.. extras-require:: dates
+
+	pytz >=2019.1
+
+
+.. warning:: This module has not been fully tested. Use with caution.
+
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
@@ -83,7 +91,7 @@ def get_utc_offset(
 
 	def get_timezone(tz: str, date: Optional[datetime.datetime] = None) -> Optional[datetime.tzinfo]:
 		"""
-		Returns a localized :class:`pytz.timezone` object for the given date.
+		Returns a localized ``pytz.timezone`` object for the given date.
 		If ``date`` is :py:obj:`None` then the current date is used.
 
 		:param tz: A string representing a pytz timezone
@@ -109,7 +117,7 @@ def get_timezone(tz: str, date: Optional[datetime.datetime] = None) -> Optional[
 Some functions in 'domdf_python_tools.dates' require pytz (https://pypi.org/project/pytz/), \
 but it could not be imported.
 
-The error was {e}.
+The error was: {e}.
 """,
 			)
 

domdf_python_tools/testing.py

@@ -8,7 +8,6 @@
 	:__pkginfo__:
 
 .. versionadded:: 0.4.9
-
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
@@ -46,7 +45,7 @@
 # this package
 from domdf_python_tools.doctools import PYPY
 from domdf_python_tools.paths import PathPlus
-from domdf_python_tools.utils import Len
+from domdf_python_tools.iterative import Len
 from domdf_python_tools.versions import Version
 
 __all__ = [
@@ -66,6 +65,8 @@
 		"pytest_report_header",
 		]
 
+MarkDecorator.__module__ = "_pytest.mark"
+
 
 def generate_truthy_values(extra_truthy: Sequence = (), ratio: float = 1) -> Iterator[Any]:
 	"""

domdf_python_tools/utils.py

@@ -78,14 +78,13 @@
 import difflib
 import functools
 import inspect
-import itertools
 import sys
 import textwrap
 import typing
 import warnings
 from datetime import date
 from pprint import pformat
-from typing import Any, Callable, Dict, Generator, Iterable, List, Optional, Sequence, Tuple, Union
+from typing import Any, Callable, Dict, Iterable, List, Optional, Sequence, Tuple, Union
 
 # 3rd party
 import deprecation  # type: ignore

repo_helper.yml

@@ -60,6 +60,7 @@ tox_testenv_extras: all
 intersphinx_mapping:
  - "'pandas': ('https://pandas.pydata.org/docs/', None)"
  - "'consolekit': ('https://consolekit.readthedocs.io/en/latest/', None)"
+ - "'pytest': ('https://docs.pytest.org/en/stable', None)"
 
 mypy_deps:
  - pprint36

requirements.txt

@@ -2,5 +2,6 @@ colorama>=0.4.3
 deprecation>=2.1.0
 importlib_metadata>=1.5.0; python_version < "3.8"
 importlib_resources>=3.0.0; python_version < "3.7"
+packaging>=20.4
 pydash>=4.7.4
 typing_extensions>=3.7.4.3