Update docs.

Author: domdfcoding

doc-source/api/testing.rst

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

doc-source/conf.py

@@ -13,6 +13,8 @@
 from __pkginfo__ import __version__
 
 # User-configurable lines
+import domdf_python_tools
+domdf_python_tools.__docs = True
 # End of user-configurable lines
 
 github_username = "domdfcoding"
@@ -37,6 +39,7 @@
 	'sphinx_toolbox',
 	'sphinx_toolbox.more_autodoc',
 	'sphinx_toolbox.more_autosummary',
+	'sphinx_toolbox.tweaks.param_dash',
 	'sphinx.ext.intersphinx',
 	'sphinx.ext.mathjax',
 	'sphinxcontrib.httpdomain',
@@ -48,7 +51,6 @@
 	'sphinxcontrib.default_values',
 	'sphinxcontrib.toctree_plus',
 	'seed_intersphinx_mapping',
-	'sphinx.ext.autosectionlabel',
 	]
 
 sphinxemoji_style = 'twemoji'
@@ -136,6 +138,3 @@
 				"__hash__",
 				]),
 		}
-
-
-set_type_checking_flag = True

doc-source/requirements.txt

@@ -2,13 +2,14 @@ autodocsumm>=0.2.0
 default_values>=0.2.0
 domdf_sphinx_theme>=0.1.0
 extras_require>=0.2.0
+pandas>=1.1.2
 seed_intersphinx_mapping>=0.1.1
 sphinx>=3.0.3
 sphinx-copybutton>=0.2.12
 sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=0.8.1
+sphinx-toolbox>=1.0.0
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
 toctree_plus>=0.0.4

domdf_python_tools/__init__.py

@@ -29,3 +29,5 @@
 __license__: str = "LGPLv3+"
 __version__: str = "0.8.3"
 __email__: str = "[email protected]"
+
+__docs = False

domdf_python_tools/testing.py

@@ -4,7 +4,8 @@
 """
 Handy functions for testing code.
 
-Requires `pytest <https://docs.pytest.org/en/stable/>`_ to be installed.
+.. extras-require:: testing
+	:__pkginfo__:
 
 .. versionadded:: 0.4.9
 """

domdf_python_tools/typing.py

@@ -39,14 +39,18 @@
 # stdlib
 import os
 import pathlib
+import typing
 from decimal import Decimal
 from json import JSONDecoder, JSONEncoder
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, Type, Union
+from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union
 
 # 3rd party
 from typing_extensions import Protocol, runtime_checkable
 
-if TYPE_CHECKING:
+# this package
+import domdf_python_tools
+
+if typing.TYPE_CHECKING or domdf_python_tools.__docs:
 	# 3rd party
 	from pandas._typing import FrameOrSeries  # type: ignore
 

domdf_python_tools/utils.py

@@ -54,8 +54,9 @@
 import inspect
 import itertools
 import sys
+import typing
 from pprint import pformat
-from typing import TYPE_CHECKING, Any, Callable, Dict, Generator, Iterable, List, Optional, Sequence, Tuple, Union
+from typing import Any, Callable, Dict, Generator, Iterable, List, Optional, Sequence, Tuple, Union
 
 # 3rd party
 import deprecation  # type: ignore
@@ -66,7 +67,7 @@
 from domdf_python_tools.terminal_colours import Colour, Fore
 from domdf_python_tools.typing import HasHead, String
 
-if TYPE_CHECKING:
+if typing.TYPE_CHECKING or domdf_python_tools.__docs:
 	# 3rd party
 	from pandas import DataFrame, Series  # type: ignore
 

domdf_python_tools/versions.py

@@ -24,6 +24,7 @@
 #
 
 # stdlib
+import re
 from typing import Generator, Sequence, Tuple, Union
 
 __all__ = ["Version"]
@@ -176,13 +177,13 @@ def from_str(cls, version_string: str) -> "Version":
 
 		:param version_string: The version number.
 
-		:return: The created Version
+		:return: The created :class:`~domdf_python_tools.versions.Version`.
 		"""
 
 		return cls(*_iter_string(version_string))
 
 	@classmethod
-	def from_tuple(cls, version_tuple: Tuple[Union[str, int], Union[str, int], Union[str, int]]) -> "Version":
+	def from_tuple(cls, version_tuple: Tuple[Union[str, int], ...]) -> "Version":
 		"""
 		Create a :class:`~.Version` from a :class:`tuple`.
 
@@ -200,7 +201,7 @@ def from_float(cls, version_float: float) -> "Version":
 
 		:param version_float: The version number.
 
-		:return: The created Version
+		:return: The created :class:`~domdf_python_tools.versions.Version`.
 		"""
 
 		return cls.from_str(str(version_float))

repo_helper.yml

@@ -40,6 +40,8 @@ classifiers:
 extras_require:
   dates:
     - pytz>=2019.1
+  testing:
+    - pytest>=6.0.0
 
 keywords:
   - utilities
@@ -50,5 +52,8 @@ yapf_exclude:
 manifest_additional:
   - "include domdf_python_tools/google-10000-english-no-swears.txt"
 
-sphinx_conf_epilogue:
-  - set_type_checking_flag = True
+sphinx_conf_preamble:
+  - import domdf_python_tools
+  - domdf_python_tools.__docs = True
+
+tox_testenv_extras: all

tox.ini

@@ -31,6 +31,8 @@ setenv =
     PIP_USE_FEATURE=2020-resolver
     PYTEST_ADDOPTS = --color yes
 deps = -r{toxinidir}/tests/requirements.txt
+
+extras = all
 commands =
     python --version
     python -m pytest --cov=domdf_python_tools -r aR tests/ --durations 25 {posargs}
@@ -40,6 +42,8 @@ commands =
 setenv = SHOW_TODOS = 1
 basepython = python3.8
 changedir = {toxinidir}/doc-source
+
+extras = all
 deps =
     -r{toxinidir}/requirements.txt
     -r{toxinidir}/doc-source/requirements.txt
@@ -108,7 +112,7 @@ commands = isort domdf_python_tools tests
 
 [testenv:mypy]
 basepython = python3.6
-
+extras = all
 ignore_errors = true
 changedir = {toxinidir}
 deps =
@@ -122,7 +126,7 @@ commands = mypy domdf_python_tools tests {posargs}
 [testenv:pyup]
 basepython = python3.6
 skip_install = true
-
+extras = all
 ignore_errors = true
 changedir={toxinidir}
 deps = pyupgrade-directories
@@ -190,6 +194,10 @@ rst-directives =
     versionremoved
     autofunction
     confval
+    rst:directive
+    rst:directive:option
+    rst:role
+    pre-commit-shield
 per-file-ignores =
     tests/*: D100 D101 D102 D103 D104 D106 D201 D204 D207 D208 D209 D210 D211 D212 D213 D214 D215 D300 D301 D400 D402 D403 D404 D415 D417 DALL000
 pytest-parametrize-names-type = csv