Update docs.

Author: domdfcoding

doc-source/conf.py

@@ -79,3 +79,10 @@ def setup(app):
 
 
 nitpicky = True
+needspace_amount = r"5\baselineskip"
+favicons = [{
+		"rel": "icon",
+		"href": "https://python-coincidence.github.io/assets/coincidence.ico",
+		"sizes": "48x48",
+		"type": "image/vnd.microsoft.icon"
+		}]

doc-source/index.rst

@@ -129,14 +129,15 @@ Installation
 Contents
 ---------
 
+.. html-section::
+
 .. toctree::
 	:hidden:
 
 	Home<self>
 
 .. toctree::
 	:maxdepth: 3
-	:caption: Documentation
 
 	usage
 	hooks
@@ -150,6 +151,7 @@ Contents
 
 	Contributing Guide <https://contributing-to-coincidence.readthedocs.io/en/latest/>
 
+
 .. start links
 
 .. only:: html

doc-source/requirements.txt

@@ -3,15 +3,16 @@ extras-require>=0.2.0
 furo>=2020.11.19b18
 html-section>=0.1.0
 seed-intersphinx-mapping>=0.3.1
-sphinx<3.4.0,>=3.0.3
+sphinx>=3.0.3
 sphinx-copybutton>=0.2.12
 sphinx-debuginfo>=0.1.0
+sphinx-favicon>=0.2
 sphinx-licenseinfo>=0.1.1
-sphinx-notfound-page>=0.7.1
+sphinx-notfound-page>=0.5
 sphinx-prompt>=1.1.0
 sphinx-pyproject>=0.1.0
 sphinx-tabs>=1.1.13
-sphinx-toolbox>=2.13.0
+sphinx-toolbox>=3.0.0a4
 sphinxcontrib-httpdomain>=1.7.0
 sphinxemoji>=0.1.6
 toctree-plus>=0.5.0

pyproject.toml

@@ -54,6 +54,7 @@ extensions = [
     "sphinx_toolbox.more_autosummary",
     "sphinx_toolbox.documentation_summary",
     "sphinx_toolbox.tweaks.param_dash",
+    "sphinxcontrib.toctree_plus",
     "sphinx_toolbox.tweaks.latex_layout",
     "sphinx_toolbox.tweaks.latex_toc",
     "sphinx.ext.intersphinx",
@@ -64,11 +65,12 @@ extensions = [
     "notfound.extension",
     "sphinx_copybutton",
     "sphinxcontrib.default_values",
-    "sphinxcontrib.toctree_plus",
     "sphinx_debuginfo",
     "sphinx_licenseinfo",
     "seed_intersphinx_mapping",
     "html_section",
+    "sphinx_toolbox.more_autosummary.column_widths",
+    "sphinx-favicon",
 ]
 sphinxemoji_style = "twemoji"
 gitstamp_fmt = "%d %b %Y"

repo_helper.yml

@@ -28,6 +28,8 @@ entry_points:
 
 sphinx_conf_epilogue:
  - nitpicky = True
+ - needspace_amount = r"5\baselineskip"
+ - 'favicons = [{"rel": "icon", "href": "https://python-coincidence.github.io/assets/coincidence.ico",  "sizes": "48x48", "type": "image/vnd.microsoft.icon"}]'
 
 intersphinx_mapping:
  - '"tox": ("https://tox.readthedocs.io/en/latest/", None)'
@@ -48,3 +50,7 @@ exclude_files:
 
 mypy_deps:
  - types-first
+
+extra_sphinx_extensions:
+ - sphinx_toolbox.more_autosummary.column_widths
+ - sphinx-favicon

tox_recreate_hook/hooks.py

@@ -48,7 +48,7 @@ def rmdir(path: PathLike) -> str:
 
 	.. attention::
 
-		On Windows-like systems using ``\`` as a path separator
+		To support Windows-like systems using ``\`` as a path separator
 		you may need to use a *raw string* for the path as the ``toxinidir``
 		substitution may contain backslashes: