Updated docs.

Author: domdfcoding

doc-source/conf.py

@@ -55,7 +55,6 @@
 	'sphinxcontrib.toctree_plus',
 	'seed_intersphinx_mapping',
 	'sphinx.ext.autosectionlabel',
-	'patched_autosummary',
 	]
 
 sphinxemoji_style = 'twemoji'
@@ -100,7 +99,21 @@
 man_pages = [('index', slug, project, [author], 1)]
 texinfo_documents = [('index', slug, project, author, slug, project, 'Miscellaneous')]
 
-toctree_plus_types = {"class", "function", "method", "data"}
+toctree_plus_types = {
+		"class",
+		"function",
+		"method",
+		"data",
+		"enum",
+		"flag",
+		"confval",
+		"directive",
+		"confval",
+		"protocol",
+		"typeddict",
+		}
+
+add_module_names = False
 
 
 autodoc_default_options = {

doc-source/requirements.txt

@@ -1,5 +1,5 @@
 autodocsumm>=0.2.0
-default_values>=0.0.10
+default_values>=0.0.11
 domdf_sphinx_theme>=0.1.0
 extras_require>=0.2.0
 seed_intersphinx_mapping>=0.1.1
@@ -8,7 +8,7 @@ sphinx-copybutton>=0.2.12
 sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=0.5.0
+sphinx-toolbox>=0.5.1
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
 toctree_plus>=0.0.4

domdf_python_tools/typing.py

@@ -15,8 +15,6 @@
 	:data:`~.MethodWrapperType`, The type of *bound* methods of some built-in data types and base classes.
 	:data:`~.MethodDescriptorType`, The type of methods of some built-in data types.
 	:data:`~.ClassMethodDescriptorType`, The type of *unbound* class methods of some built-in data types.
-	:data:`~.String`, :class:`~typing.Protocol` for classes that implement ``__str__``.
-	:data:`~.HasHead`, :class:`typing.Protocol` for classes that have a ``head``.
 
 """
 #
@@ -186,18 +184,26 @@ def __str__(self) -> str:
 @runtime_checkable
 class HasHead(Protocol):
 	"""
-	:class:`typing.Protocol` for classes that have a ``head``.
+	:class:`typing.Protocol` for classes that have a ``head`` method.
 
 	This includes :class:`pandas.DataFrame` and :class:`pandas.Series`.
 
 	.. versionadded:: 0.8.0
 	"""
 
 	def head(self: "FrameOrSeries", n: int = 5) -> "FrameOrSeries":
-		...  # pragma: no cover
+		"""
+		Return the first n rows.
+
+		:param n: Number of rows to select.
+
+		:return: The first n rows of the caller object.
+		"""
 
 	def to_string(self, *args, **kwargs) -> Optional[str]:
-		...  # pragma: no cover
+		"""
+		Render the object to a console-friendly tabular output.
+		"""
 
 
 # class SupportsLessThan(Protocol):