Pin sphinxcontrib-* for docs and workaround sphinxemoji issue in conf.py

repo_helper/files/docs.py

@@ -88,11 +88,16 @@
 
 class DocRequirementsManager(RequirementsManager):
 	target_requirements = {
-			ComparableRequirement("sphinxemoji>=0.1.6"),  # latest 0.2.0
-			ComparableRequirement("sphinx-notfound-page>=0.5"),  # latest 0.8.3
-			ComparableRequirement("sphinx-copybutton>=0.2.12"),  # latest 0.5.2
+			ComparableRequirement("sphinxemoji>=0.1.6"),
+			ComparableRequirement("sphinx-notfound-page>=0.5"),
+			ComparableRequirement("sphinx-copybutton>=0.2.12"),
 			ComparableRequirement("sphinx-pyproject>=0.1.0"),
-			# ComparableRequirement("sphinx-autodoc-typehints==1.11.1"),
+			ComparableRequirement("sphinxcontrib-applehelp==1.0.4"),
+			ComparableRequirement("sphinxcontrib-devhelp==1.0.2"),
+			ComparableRequirement("sphinxcontrib-htmlhelp==2.0.1"),
+			ComparableRequirement("sphinxcontrib-jsmath==1.0.1"),
+			ComparableRequirement("sphinxcontrib-qthelp==1.0.3"),
+			ComparableRequirement("sphinxcontrib-serializinghtml==1.1.5"),
 			}
 
 	def __init__(self, repo_path: PathLike, templates: Environment):

repo_helper/templates/conf._py

@@ -71,15 +71,30 @@ latex_elements = {
 		}
 
 
+# Fix for pathlib issue with sphinxemoji on Python 3.9 and Sphinx 4.x
+def copy_asset_files(app, exc):
+	from domdf_python_tools.compat import importlib_resources
+	from sphinx.util.fileutil import copy_asset
+
+	if exc:
+		return
+
+	asset_files = ['twemoji.js', 'twemoji.css']
+	for path in asset_files:
+		path_str = os.fspath(importlib_resources.files('sphinxemoji') / path)
+		copy_asset(path_str, os.path.join(app.outdir, '_static'))
+
+
 def setup(app):
+	# 3rd party
 	from sphinx_toolbox.latex import better_header_layout
 	from sphinxemoji import sphinxemoji
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
-	app.connect('build-finished', sphinxemoji.copy_asset_files)
-	app.add_js_file('https://unpkg.com/twemoji@latest/dist/twemoji.min.js')
-	app.add_js_file('twemoji.js')
-	app.add_css_file('twemoji.css')
+	app.connect("build-finished", copy_asset_files)
+	app.add_js_file("https://unpkg.com/twemoji@latest/dist/twemoji.min.js")
+	app.add_js_file("twemoji.js")
+	app.add_css_file("twemoji.css")
 	app.add_transform(sphinxemoji.EmojiSubstitutions)
 
 {% for line in sphinx_conf_epilogue %}{{ line }}

tests/test_files/test_docs.py

@@ -138,6 +138,12 @@ def test_ensure_doc_requirements(tmp_pathplus: PathPlus, demo_environment: Envir
 			"sphinx-notfound-page>=0.5",
 			"sphinx-pyproject>=0.1.0",
 			"sphinx-toolbox>=3.5.0",
+			"sphinxcontrib-applehelp==1.0.4",
+			"sphinxcontrib-devhelp==1.0.2",
+			"sphinxcontrib-htmlhelp==2.0.1",
+			"sphinxcontrib-jsmath==1.0.1",
+			"sphinxcontrib-qthelp==1.0.3",
+			"sphinxcontrib-serializinghtml==1.1.5",
 			"sphinxemoji>=0.1.6",
 			"toctree-plus>=0.6.1",
 			'',
@@ -163,6 +169,12 @@ def test_ensure_doc_requirements(tmp_pathplus: PathPlus, demo_environment: Envir
 			"sphinx-notfound-page>=0.5",
 			"sphinx-pyproject>=0.1.0",
 			"sphinx-toolbox>=3.5.0",
+			"sphinxcontrib-applehelp==1.0.4",
+			"sphinxcontrib-devhelp==1.0.2",
+			"sphinxcontrib-htmlhelp==2.0.1",
+			"sphinxcontrib-jsmath==1.0.1",
+			"sphinxcontrib-qthelp==1.0.3",
+			"sphinxcontrib-serializinghtml==1.1.5",
 			"sphinxemoji>=0.1.6",
 			"toctree-plus>=0.6.1",
 			'',

tests/test_files/test_docs_/test_make_conf_alabaster_._py_

@@ -70,13 +70,28 @@ latex_elements = {
 		}
 
 
+# Fix for pathlib issue with sphinxemoji on Python 3.9 and Sphinx 4.x
+def copy_asset_files(app, exc):
+	# 3rd party
+	from domdf_python_tools.compat import importlib_resources
+	from sphinx.util.fileutil import copy_asset
+
+	if exc:
+		return
+
+	asset_files = ["twemoji.js", "twemoji.css"]
+	for path in asset_files:
+		path_str = os.fspath(importlib_resources.files("sphinxemoji") / path)
+		copy_asset(path_str, os.path.join(app.outdir, "_static"))
+
+
 def setup(app):
 	# 3rd party
 	from sphinx_toolbox.latex import better_header_layout
 	from sphinxemoji import sphinxemoji
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
-	app.connect("build-finished", sphinxemoji.copy_asset_files)
+	app.connect("build-finished", copy_asset_files)
 	app.add_js_file("https://unpkg.com/twemoji@latest/dist/twemoji.min.js")
 	app.add_js_file("twemoji.js")
 	app.add_css_file("twemoji.css")

tests/test_files/test_docs_/test_make_conf_domdf_sphinx_theme_._py_

@@ -66,13 +66,28 @@ latex_elements = {
 		}
 
 
+# Fix for pathlib issue with sphinxemoji on Python 3.9 and Sphinx 4.x
+def copy_asset_files(app, exc):
+	# 3rd party
+	from domdf_python_tools.compat import importlib_resources
+	from sphinx.util.fileutil import copy_asset
+
+	if exc:
+		return
+
+	asset_files = ["twemoji.js", "twemoji.css"]
+	for path in asset_files:
+		path_str = os.fspath(importlib_resources.files("sphinxemoji") / path)
+		copy_asset(path_str, os.path.join(app.outdir, "_static"))
+
+
 def setup(app):
 	# 3rd party
 	from sphinx_toolbox.latex import better_header_layout
 	from sphinxemoji import sphinxemoji
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
-	app.connect("build-finished", sphinxemoji.copy_asset_files)
+	app.connect("build-finished", copy_asset_files)
 	app.add_js_file("https://unpkg.com/twemoji@latest/dist/twemoji.min.js")
 	app.add_js_file("twemoji.js")
 	app.add_css_file("twemoji.css")

tests/test_files/test_docs_/test_make_conf_furo_._py_

@@ -71,13 +71,28 @@ latex_elements = {
 		}
 
 
+# Fix for pathlib issue with sphinxemoji on Python 3.9 and Sphinx 4.x
+def copy_asset_files(app, exc):
+	# 3rd party
+	from domdf_python_tools.compat import importlib_resources
+	from sphinx.util.fileutil import copy_asset
+
+	if exc:
+		return
+
+	asset_files = ["twemoji.js", "twemoji.css"]
+	for path in asset_files:
+		path_str = os.fspath(importlib_resources.files("sphinxemoji") / path)
+		copy_asset(path_str, os.path.join(app.outdir, "_static"))
+
+
 def setup(app):
 	# 3rd party
 	from sphinx_toolbox.latex import better_header_layout
 	from sphinxemoji import sphinxemoji
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
-	app.connect("build-finished", sphinxemoji.copy_asset_files)
+	app.connect("build-finished", copy_asset_files)
 	app.add_js_file("https://unpkg.com/twemoji@latest/dist/twemoji.min.js")
 	app.add_js_file("twemoji.js")
 	app.add_css_file("twemoji.css")

tests/test_files/test_docs_/test_make_conf_sphinx_rtd_theme_._py_

@@ -66,13 +66,28 @@ latex_elements = {
 		}
 
 
+# Fix for pathlib issue with sphinxemoji on Python 3.9 and Sphinx 4.x
+def copy_asset_files(app, exc):
+	# 3rd party
+	from domdf_python_tools.compat import importlib_resources
+	from sphinx.util.fileutil import copy_asset
+
+	if exc:
+		return
+
+	asset_files = ["twemoji.js", "twemoji.css"]
+	for path in asset_files:
+		path_str = os.fspath(importlib_resources.files("sphinxemoji") / path)
+		copy_asset(path_str, os.path.join(app.outdir, "_static"))
+
+
 def setup(app):
 	# 3rd party
 	from sphinx_toolbox.latex import better_header_layout
 	from sphinxemoji import sphinxemoji
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
-	app.connect("build-finished", sphinxemoji.copy_asset_files)
+	app.connect("build-finished", copy_asset_files)
 	app.add_js_file("https://unpkg.com/twemoji@latest/dist/twemoji.min.js")
 	app.add_js_file("twemoji.js")
 	app.add_css_file("twemoji.css")