Update docs.

domdfcoding · domdfcoding · commit af465372e4c1 · 2022-05-12T13:11:15.000+01:00
diff --git a/doc-source/api/bases.rst b/doc-source/api/bases.rst
@@ -3,7 +3,6 @@
 ==================================
 
 .. autosummary-widths:: 5/16
-	:html: 2/10
 
 .. automodule:: domdf_python_tools.bases
 	:autosummary-members:
@@ -92,6 +91,7 @@ UserFloat
 	:special-members:
 	:exclude-members: __ceil__,__floor__,conjugate,imag,real
 
+.. latex:clearpage::
 
 Lineup
 ---------
diff --git a/doc-source/api/dates.rst b/doc-source/api/dates.rst
@@ -3,7 +3,6 @@
 =================================
 
 .. autosummary-widths:: 13/32
-	:html: 35/100
 
 .. automodule:: domdf_python_tools.dates
 	:undoc-members:
diff --git a/doc-source/api/delegators.rst b/doc-source/api/delegators.rst
@@ -3,7 +3,6 @@
 =====================================
 
 .. autosummary-widths:: 1/2
-	:html: 25/100
 
 .. automodule:: domdf_python_tools.delegators
 	:members: _C,delegate_kwargs,delegates
diff --git a/doc-source/api/doctools.rst b/doc-source/api/doctools.rst
@@ -2,5 +2,7 @@
 :mod:`~domdf_python_tools.doctools`
 ===================================
 
+.. latex:vspace:: -20px
+
 .. automodule:: domdf_python_tools.doctools
 	:undoc-members:
diff --git a/doc-source/api/getters.rst b/doc-source/api/getters.rst
@@ -2,8 +2,7 @@
 :mod:`~domdf_python_tools.getters`
 =======================================
 
-.. autosummary-widths:: 1/2
-	:html: 4/10
+.. autosummary-widths:: 45/100
 
 .. automodule:: domdf_python_tools.getters
 	:no-show-inheritance:
diff --git a/doc-source/api/import_tools.rst b/doc-source/api/import_tools.rst
@@ -3,7 +3,6 @@
 =======================================
 
 .. autosummary-widths:: 1/2
-	:html: 4/10
 
 .. automodule:: domdf_python_tools.import_tools
 	:undoc-members:
diff --git a/doc-source/api/iterative.rst b/doc-source/api/iterative.rst
@@ -3,6 +3,5 @@
 ====================================
 
 .. autosummary-widths:: 7/16
-	:html: 28/100
 
 .. automodule:: domdf_python_tools.iterative
diff --git a/doc-source/api/pagesizes/classes.rst b/doc-source/api/pagesizes/classes.rst
@@ -3,7 +3,6 @@
 ============================================
 
 .. autosummary-widths:: 7/16
-	:html: 3/10
 
 .. automodule:: domdf_python_tools.pagesizes.classes
 	:undoc-members:
diff --git a/doc-source/api/pagesizes/units.rst b/doc-source/api/pagesizes/units.rst
@@ -3,7 +3,6 @@
 ===========================================
 
 .. autosummary-widths:: 1/2
-	:html: 2/10
 
 .. automodule:: domdf_python_tools.pagesizes.units
 	:autosummary-members:
diff --git a/doc-source/api/pagesizes/utils.rst b/doc-source/api/pagesizes/utils.rst
@@ -3,7 +3,6 @@
 ===========================================
 
 .. autosummary-widths:: 7/16
-	:html: 3/10
 
 .. automodule:: domdf_python_tools.pagesizes.utils
 	:undoc-members:
diff --git a/doc-source/api/paths.rst b/doc-source/api/paths.rst
@@ -2,8 +2,7 @@
 :mod:`~domdf_python_tools.paths`
 =================================
 
-.. autosummary-widths:: 1/2
-	:html: 35/100
+.. autosummary-widths:: 45/100
 
 .. automodule:: domdf_python_tools.paths
 	:undoc-members:
diff --git a/doc-source/api/pretty_print.rst b/doc-source/api/pretty_print.rst
@@ -3,6 +3,5 @@
 =======================================
 
 .. autosummary-widths:: 1/2
-	:html: 35/100
 
 .. automodule:: domdf_python_tools.pretty_print
diff --git a/doc-source/api/secrets.rst b/doc-source/api/secrets.rst
@@ -3,7 +3,6 @@
 ==================================
 
 .. autosummary-widths:: 4/16
-	:html: 2/10
 
 .. automodule:: domdf_python_tools.secrets
 	:special-members:
diff --git a/doc-source/api/stringlist.rst b/doc-source/api/stringlist.rst
@@ -3,7 +3,6 @@
 =====================================
 
 .. autosummary-widths:: 51/128
-	:html: 3/10
 
 .. automodule:: domdf_python_tools.stringlist
 	:no-members:
diff --git a/doc-source/api/terminal.rst b/doc-source/api/terminal.rst
@@ -3,7 +3,6 @@
 ===================================
 
 .. autosummary-widths:: 13/32
-	:html: 3/10
 
 .. automodule:: domdf_python_tools.terminal
 	:undoc-members:
diff --git a/doc-source/api/typing.rst b/doc-source/api/typing.rst
@@ -81,6 +81,8 @@ Protocols
 .. autoprotocol:: SupportsGreaterEqual
 
 
+.. latex:clearpage::
+
 Utility Functions
 ---------------------
 
diff --git a/doc-source/api/utils.rst b/doc-source/api/utils.rst
@@ -3,6 +3,4 @@
 =================================
 
 .. autosummary-widths:: 1/2
-	:html: 35/100
-
 .. automodule:: domdf_python_tools.utils
diff --git a/doc-source/api/versions.rst b/doc-source/api/versions.rst
@@ -3,7 +3,6 @@
 ===================================
 
 .. autosummary-widths:: 1/2
-	:html: 3/10
 
 .. automodule:: domdf_python_tools.versions
 	:undoc-members:
diff --git a/doc-source/api/words.rst b/doc-source/api/words.rst
@@ -37,7 +37,6 @@ Fonts
 ------
 
 .. autosummary-widths:: 13/32
-	:html: 3/10
 
 .. automodulesumm:: domdf_python_tools.words
 	:autosummary-members: make_font,Font,SERIF_BOLD_LETTERS,SERIF_ITALIC_LETTERS,SERIF_BOLD_ITALIC_LETTERS,SANS_SERIF_LETTERS,SANS_SERIF_BOLD_LETTERS,SANS_SERIF_ITALIC_LETTERS,SANS_SERIF_BOLD_ITALIC_LETTERS,SCRIPT_LETTERS,FRAKTUR_LETTERS,MONOSPACE_LETTERS,DOUBLESTRUCK_LETTERS
@@ -104,7 +103,6 @@ Functions
 -------------
 
 .. autosummary-widths:: 8/16
-	:html: 31/100
 
 .. automodulesumm:: domdf_python_tools.words
 	:autosummary-members: alpha_sort,get_words_list,get_random_word,as_text,word_join
@@ -115,11 +113,13 @@ Functions
 .. autofunction:: domdf_python_tools.words.get_random_word
 .. autofunction:: domdf_python_tools.words.word_join
 
+
+.. latex:clearpage::
+
 Classes
 -------------
 
 .. autosummary-widths:: 8/16
-	:html: 31/100
 
 .. automodulesumm:: domdf_python_tools.words
 	:autosummary-members: Plural,PluralPhrase
diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -84,3 +84,4 @@ def setup(app):
 manpages_url = "https://manpages.debian.org/{path}"
 toctree_plus_types.add("fixture")
 latex_elements["preamble"] = "\\usepackage{textgreek}\\usepackage{multicol}"
+needspace_amount = r"5\baselineskip"
diff --git a/doc-source/latex_unicode.py b/doc-source/latex_unicode.py
@@ -52,7 +52,7 @@
 from sphinx_toolbox import latex
 from sphinx_toolbox.more_autodoc.typehints import default_preprocessors, format_annotation
 from sphinx_toolbox.more_autosummary import PatchedAutoSummClassDocumenter
-from sphinx_toolbox_experimental.autosummary_widths import AutosummaryWidths
+from sphinx_toolbox.more_autosummary.column_widths import AutosummaryWidths
 
 # this package
 from domdf_python_tools.paths import PathPlus
diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt
@@ -1,4 +1,3 @@
-git+https://github.com/sphinx-toolbox/sphinx-toolbox-experimental.git
 default-values>=0.5.0
 domdf-sphinx-theme>=0.3.0
 extras-require>=0.2.0
@@ -19,7 +18,7 @@ sphinx-notfound-page>=0.7.1
 sphinx-prompt>=1.1.0
 sphinx-pyproject>=0.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=2.13.0b3
+sphinx-toolbox>=3.0.0
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
 toctree-plus>=0.5.0
diff --git a/domdf_python_tools/bases.py b/domdf_python_tools/bases.py
@@ -140,6 +140,8 @@ class UserList(MutableSequence[_T]):
 	:param initlist: The initial values to populate the :class:`~.UserList` with.
 	:default initlist: ``[]``
 
+	.. latex:clearpage::
+
 	.. admonition:: Subclassing requirements
 
 		Subclasses of :class:`~.UserList` are expected to offer a constructor which can be called with
@@ -290,7 +292,11 @@ def remove(self, item: _T) -> None:
 
 		:param item:
 
+		:rtype:
+
 		:raises ValueError: if the item is not present.
+
+		.. latex:clearpage::
 		"""
 
 		self.data.remove(item)
@@ -573,8 +579,6 @@ class NamedList(UserList[_T]):
 	.. versionchanged:: 0.10.0
 
 		:class:`~.NamedList` now subclasses :class:`.UserList` rather than :class:`collections.UserList`.
-
-	.. latex:clearpage::
 	"""
 
 	def __repr__(self) -> str:
diff --git a/domdf_python_tools/doctools.py b/domdf_python_tools/doctools.py
@@ -10,7 +10,6 @@
 	:autosummary-sections: Data
 
 .. autosummary-widths:: 17/32
-	:html: 4/10
 
 .. automodulesumm:: domdf_python_tools.doctools
 	:autosummary-sections: Functions
@@ -143,9 +142,7 @@ def make_sphinx_links(input_string: str, builtins_list: Optional[Sequence[str]]
 
 	.. code-block:: python
 
-		intersphinx_mapping = {
-			"python": ("https://docs.python.org/3/", None),
-		}
+		intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
 
 	:param input_string: The string to process.
 	:param builtins_list: A list of builtins to make links for.
diff --git a/domdf_python_tools/import_tools.py b/domdf_python_tools/import_tools.py
@@ -120,12 +120,12 @@ def discover_in_module(
 	"""
 	Returns a list of objects in the given module, optionally filtered by ``match_func``.
 
+	.. versionadded:: 2.6.0
+
 	:param module: A Python module.
 	:param match_func: Function taking an object and returning :py:obj:`True` if the object is to be included in the output.
 	:default match_func: :py:obj:`None`, which includes all objects.
 	:param exclude_side_effects: Don't include objects that are only there because of an import side effect.
-
-	.. versionadded:: 2.6.0
 	"""
 
 	matching_objects = []
diff --git a/domdf_python_tools/pagesizes/units.py b/domdf_python_tools/pagesizes/units.py
@@ -120,9 +120,8 @@ class Unit(float):
 		>>> 17 - (7*cm)
 		<Unit '10.000 cm': 283.465pt>
 
-	.. latex:clearpage::
 
-	:bold-title:`Multiplcation`
+	:bold-title:`Multiplication`
 
 	:class:`~domdf_python_tools.pagesizes.units.Unit` objects can only be multipled by
 	:class:`float` and :class:`int` objects:
diff --git a/domdf_python_tools/paths.py b/domdf_python_tools/paths.py
@@ -171,8 +171,6 @@ def copytree(
 	In Python 3.8 and above :func:`shutil.copytree` takes a ``dirs_exist_ok`` argument,
 	which has the same result.
 
-	.. latex:clearpage::
-
 	:param src: Source file to copy
 	:param dst: Destination to copy file to
 	:param symlinks: Whether to represent symbolic links in the source as symbolic
@@ -819,10 +817,18 @@ def is_relative_to(self, *other: Union[str, os.PathLike]) -> bool:
 			r"""
 			Returns whether the path is relative to another path.
 
-			.. versionadded:: 0.3.8 for Python 3.9 and above
-			.. versionadded:: 1.4.0 for Python 3.6 and Python 3.7
+			.. versionadded:: 0.3.8 for Python 3.9 and above.
+			.. latex:vspace:: -10px
+			.. versionadded:: 1.4.0 for Python 3.6 and Python 3.7.
+			.. latex:vspace:: -10px
 
 			:param \*other:
+
+			.. latex:vspace:: -20px
+
+			:rtype:
+
+			.. latex:vspace:: -20px
 			"""
 
 			try:
@@ -1052,7 +1058,6 @@ def matchglob(filename: PathLike, pattern: str, matchcase: bool = True) -> bool:
 
 	.. seealso:: :wikipedia:`Glob (programming)#Syntax` on Wikipedia
 	.. versionchanged:: 2.5.0  Added the ``matchcase`` option.
-	.. latex:clearpage::
 	"""
 
 	match_func = fnmatch.fnmatchcase if matchcase else fnmatch.fnmatch
diff --git a/domdf_python_tools/secrets.py b/domdf_python_tools/secrets.py
@@ -52,9 +52,7 @@ class Secret(str):
 		True
 
 	.. versionadded:: 0.4.6
-
 	.. autosummary-widths:: 1/2
-		:html: 2/10
 	"""
 
 	__slots__ = ("value", )
diff --git a/domdf_python_tools/stringlist.py b/domdf_python_tools/stringlist.py
@@ -318,8 +318,6 @@ def set_indent_type(self, indent_type: str = '\t'):
 		Sets the type of the indent to insert at the beginning of new lines.
 
 		:param indent_type: The type of indent to use for new lines.
-
-		.. latex:clearpage::
 		"""
 
 		self.indent.type = str(indent_type)
diff --git a/domdf_python_tools/typing.py b/domdf_python_tools/typing.py
@@ -173,6 +173,10 @@ def loads(
 		:param parse_constant:
 		:param object_pairs_hook:
 		:param kwds:
+
+		:rtype:
+
+		.. latex:clearpage::
 		"""
 
 
diff --git a/domdf_python_tools/utils.py b/domdf_python_tools/utils.py
@@ -247,7 +247,7 @@ def stderr_writer(
 	print(*values, sep=sep, end=end, file=sys.stderr, flush=True)
 	sys.stderr.flush()
 
-
+#: Alias of :func:`~.stderr_writer`
 printe = stderr_writer
 
 
@@ -500,10 +500,6 @@ def double_repr_string(string: str) -> str:
 	.. versionadded:: 2.5.0
 
 	:param string:
-
-	:rtype:
-
-	.. latex:clearpage::
 	"""
 
 	# figure out which quote to use; double is preferred
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/repo_helper.yml b/repo_helper.yml
