Update docs.

Author: domdfcoding

doc-source/conf.py

@@ -55,6 +55,7 @@
 	'sphinxcontrib.toctree_plus',
 	'seed_intersphinx_mapping',
 	'sphinx.ext.autosectionlabel',
+	'patched_autosummary',
 	]
 
 sphinxemoji_style = 'twemoji'
@@ -125,3 +126,6 @@
 				"__hash__",
 				]),
 		}
+
+
+set_type_checking_flag = True

doc-source/patched_autosummary.py

@@ -0,0 +1,35 @@
+# stdlib
+import re
+from typing import Any, Dict, List, Tuple
+
+# 3rd party
+import sphinx
+from sphinx.application import Sphinx
+from sphinx.ext.autosummary import Autosummary
+
+
+class PatchedAutosummary(Autosummary):
+	"""
+	Pretty table containing short signatures and summaries of functions etc.
+
+	Patched version of :class:`sphinx.ext.autosummary.Autosummary` to fix issue where
+	the module name is sometimes duplicated.
+
+	I.e. ``foo.bar.baz()`` became ``foo.bar.foo.bar.baz()``, which of course doesn't exist
+	and so resulted in a broken link.
+	"""
+
+	def import_by_name(self, name: str, prefixes: List[str]) -> Tuple[str, Any, Any, str]:
+		real_name, obj, parent, modname = super().import_by_name(name=name, prefixes=prefixes)
+		real_name = re.sub(rf"((?:{modname}\.)+)", f"{modname}.", real_name)
+		return real_name, obj, parent, modname
+
+
+def setup(app: Sphinx) -> Dict[str, Any]:
+	app.setup_extension('sphinx.ext.autosummary')
+	app.add_directive('autosummary', PatchedAutosummary, override=True)
+
+	return {
+			'version': f"{sphinx.__display_version__}-patched-autosummary-0",
+			'parallel_read_safe': True,
+			}

doc-source/requirements.txt

@@ -1,8 +1,7 @@
 autodocsumm>=0.2.0
-default_values>=0.0.9
+default_values>=0.0.10
 domdf_sphinx_theme>=0.1.0
 extras_require>=0.2.0
-pandas>=1.0.0
 seed_intersphinx_mapping>=0.1.1
 sphinx>=3.0.3
 sphinx-copybutton>=0.2.12

repo_helper.yml

@@ -49,3 +49,6 @@ yapf_exclude:
 
 manifest_additional:
   - "include domdf_python_tools/google-10000-english-no-swears.txt"
+
+sphinx_conf_epilogue:
+  - set_type_checking_flag = True

tox.ini

@@ -170,6 +170,8 @@ rst-roles =
     wikipedia
     rst:role
     rst:dir
+    pull
+    issue
 rst-directives =
     envvar
     exception
@@ -179,6 +181,8 @@ rst-directives =
     versionchanged
     rest-example
     extras-require
+    literalinclude
+    autoclass
 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