Linting

doc-source/extensions/more_autodoc/generic_bases.rst

@@ -1,5 +1,5 @@
 =================================================
-:mod:`sphinx_toolbox.more_autodoc.generic_bases`
+:mod:`~sphinx_toolbox.more_autodoc.generic_bases`
 =================================================
 
 .. automodule:: sphinx_toolbox.more_autodoc.generic_bases

sphinx_toolbox/more_autodoc/generic_bases.py

@@ -2,7 +2,7 @@
 #
 #  generic_bases.py
 r"""
-Modifies :class:`sphinx.ext.autodoc.ClassDocumenter`\'s ``:show-inheritence: option
+Modifies :class:`sphinx.ext.autodoc.ClassDocumenter`\'s ``:show-inheritence:`` option
 to show generic base classes.
 
 This requires a relatively new version of the :mod:`typing` module that implements ``__orig_bases__``.

sphinx_toolbox/testing.py

@@ -66,10 +66,9 @@
 import sphinx.application
 from bs4 import BeautifulSoup  # type: ignore
 from docutils import nodes
-from docutils.nodes import Node  # NOQA
-from docutils.nodes import Element, TextElement
 from docutils.parsers.rst import Directive, roles
 from docutils.transforms import Transform
+from domdf_python_tools.doctools import prettify_docstrings
 from domdf_python_tools.stringlist import StringList
 from pygments.lexer import Lexer  # type: ignore
 from pytest_regressions.file_regression import FileRegressionFixture  # type: ignore
@@ -193,7 +192,7 @@ def set_translator(
 
 	def add_node(
 			self,
-			node: Type[Element],
+			node: Type[nodes.Element],
 			override: bool = False,
 			**kwargs: Tuple[Callable, Callable],
 			) -> None:
@@ -215,7 +214,7 @@ def add_node(
 
 	def add_enumerable_node(
 			self,
-			node: Type[Element],
+			node: Type[nodes.Element],
 			figtype: str,
 			title_getter: TitleGetter = None,
 			override: bool = False,
@@ -319,7 +318,7 @@ def add_object_type(
 			rolename: str,
 			indextemplate: str = '',
 			parse_node: Callable = None,
-			ref_nodeclass: Type[TextElement] = None,
+			ref_nodeclass: Type[nodes.TextElement] = None,
 			objname: str = '',
 			doc_field_types: List = [],
 			override: bool = False,
@@ -344,7 +343,7 @@ def add_crossref_type(
 			directivename: str,
 			rolename: str,
 			indextemplate: str = '',
-			ref_nodeclass: Type[TextElement] = None,
+			ref_nodeclass: Type[nodes.TextElement] = None,
 			objname: str = '',
 			override: bool = False,
 			) -> None:
@@ -523,6 +522,7 @@ def connect(self, event: str, callback: Callable, priority: int = 500) -> int:
 		return listener_id
 
 
+@prettify_docstrings
 class RunSetupOutput(NamedTuple):
 	"""
 	:class:`~typing.NamedTuple` representing the output from :func:`~sphinx_toolbox.testing.run_setup`.