Updating docs.

Author: domdfcoding

doc-source/conf.py

@@ -49,6 +49,8 @@
 		"sphinx.ext.autosummary",
 		"autodocsumm",
 		"sphinx_copybutton",
+		"sphinxcontrib.default_values",
+		"sphinxcontrib.toctree_plus",
 		# "sphinx_gitstamp",
 		]
 
@@ -96,8 +98,6 @@
 
 htmlhelp_basename = slug
 
-typehints_fully_qualified = True
-
 latex_documents = [('index', f'{slug}.tex', project, author, 'manual')]
 man_pages = [('index', slug, project, [author], 1)]
 texinfo_documents = [('index', slug, project, author, slug, project, 'Miscellaneous')]

doc-source/requirements.txt

@@ -1,4 +1,5 @@
 autodocsumm
+default_values>=0.0.4
 extras_require
 pytz>=2019.1
 sphinx>=3.0.3
@@ -10,3 +11,4 @@ sphinx_autodoc_typehints>=1.11.0
 sphinx_rtd_theme<0.5
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
+toctree_plus>=0.0.1

domdf_python_tools/dates.py

@@ -252,7 +252,7 @@ def check_date(month: Union[str, int], day: int, leap_year: bool = True) -> bool
 	:type month: str, int
 	:param day: The day number to test.
 	:type day: int
-	:param leap_year: Whether to return :py:obj:`True` for 29th Feb. Default :py:obj:`True`.
+	:param leap_year: Whether to return :py:obj:`True` for 29th Feb.
 	:type leap_year: bool, optional
 
 	:return: :py:obj:`True` if the date is valid.

domdf_python_tools/paths.py

@@ -137,11 +137,13 @@ def maybe_make(directory: PathLike, mode: int = 0o777, parents: bool = False, ex
 	:param parents: If :py:obj:`False` (the default), a missing parent raises a :class:`~python:FileNotFoundError`.
 		If :py:obj:`True`, any missing parents of this path are created as needed; they are created with the
 		default permissions without taking mode into account (mimicking the POSIX mkdir -p command).
+	:no-default parents:
 	:type parents: bool, optional
 	:param exist_ok: If :py:obj:`False` (the default), a :class:`~python:FileExistsError` is raised if the
 		target directory already exists. If :py:obj:`True`, :class:`~python:FileExistsError` exceptions
 		will be ignored (same behavior as the POSIX mkdir -p command), but only if the last path
 		component is not an existing non-directory file.
+	:no-default exist_ok:
 	:type exist_ok: bool, optional
 	"""
 
@@ -194,7 +196,8 @@ def relpath(path: PathLike, relative_to: Optional[PathLike] = None) -> pathlib.P
 
 	:param path: Path to find the relative path for
 	:param relative_to: The directory to find the path relative to.
-		Defaults to the current directory
+		Defaults to the current directory.
+	:no-default relative_to:
 
 	:return:
 	"""
@@ -312,8 +315,7 @@ def write_clean(
 		Open the file in text mode, write to it without trailing spaces, and close the file.
 
 		:param string:
-		:type string: str
-		:param encoding: The encoding to write to the file using. Default ``"UTF-8"``.
+		:param encoding: The encoding to write to the file using.
 		:param errors:
 
 		.. versionadded:: 0.3.8
@@ -336,11 +338,13 @@ def maybe_make(
 		:param parents: If :py:obj:`False` (the default), a missing parent raises a :class:`~python:FileNotFoundError`.
 			If :py:obj:`True`, any missing parents of this path are created as needed; they are created with the
 			default permissions without taking mode into account (mimicking the POSIX mkdir -p command).
+		:no-default parents:
 		:type parents: bool, optional
 		:param exist_ok: If :py:obj:`False` (the default), a :class:`~python:FileExistsError` is raised if the
 			target directory already exists. If :py:obj:`True`, :class:`~python:FileExistsError` exceptions
 			will be ignored (same behavior as the POSIX mkdir -p command), but only if the last path
 			component is not an existing non-directory file.
+		:no-default exist_ok:
 		:type exist_ok: bool, optional
 
 		.. versionadded:: 0.3.8
@@ -359,7 +363,7 @@ def append_text(
 
 		:param string:
 		:type string: str
-		:param encoding: The encoding to write to the file using. Default ``"UTF-8"``.
+		:param encoding: The encoding to write to the file using.
 		:param errors:
 
 		.. versionadded:: 0.3.8
@@ -379,7 +383,7 @@ def write_text(
 
 		:param data:
 		:type data: str
-		:param encoding: The encoding to write to the file using. Default ``"UTF-8"``.
+		:param encoding: The encoding to write to the file using.
 		:param errors:
 
 		.. versionadded:: 0.3.8
@@ -395,7 +399,7 @@ def read_text(
 		"""
 		Open the file in text mode, read it, and close the file.
 
-		:param encoding: The encoding to write to the file using. Default ``"UTF-8"``.
+		:param encoding: The encoding to write to the file using.
 		:param errors:
 
 		:return: The content of the file.
@@ -417,7 +421,8 @@ def open(
 		Open the file pointed by this path and return a file object, as
 		the built-in open() function does.
 
-		:param mode: The mode to open the file in. Default ``"r"`` (read only.
+		:param mode: The mode to open the file in.
+		:default mode: ``"r"`` (read only)
 		:type mode: str
 		:param buffering:
 		:type buffering: int

domdf_python_tools/terminal.py

@@ -119,11 +119,12 @@ def overtype(*objects, sep: str = ' ', end: str = '', file=None, flush: bool = F
 	.. TODO:: This does not currently work in the PyCharm console, at least on Windows
 
 	:param objects: A list of strings or string-like objects to write to the terminal.
-	:param sep: String to separate the objects with, by default " "
+	:param sep: String to separate the objects with.
 	:type sep: str
-	:param end: String to end with, by default nothing
+	:param end: String to end with.
 	:type end: str
-	:param file: An object with a ``write(string)`` method; default ``sys.stdout``
+	:param file: An object with a ``write(string)`` method.
+	:default file: ``sys.stdout``
 	:type file:
 	:param flush: If true, the stream is forcibly flushed.
 	:type flush: bool

tests/requirements.txt

@@ -1,8 +1,8 @@
-coverage >=5.1
-coverage_pyver_pragma >=0.0.2
+coverage>=5.1
+coverage_pyver_pragma>=0.0.2
 faker
-pytest >=6.0.0rc1
-pytest-cov >=2.8.1
-pytest-randomly >=3.3.1
-pytest-rerunfailures >=9.0
-pytz >=2019.1
+pytest>=6.0.0rc1
+pytest-cov>=2.8.1
+pytest-randomly>=3.3.1
+pytest-rerunfailures>=9.0
+pytz>=2019.1