Docs: create nice 404 pages

Currently, when a user arrives at a 404 page, Read the Docs shows the default Maze Found page without context about the setuptools project itself. This extension, `sphinx-notfound-page`, creates a `404.html` page with the same style as the rest of the documentation pages that Read the Docs will serve instead of the default Maze Found one.
pypa · Jul 13, 2022 · fe6d794 · fe6d794
1 parent 4d00d50
commit fe6d794
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/changelog.d/3444.doc.rst b/changelog.d/3444.doc.rst
@@ -0,0 +1,2 @@
+Installed ``sphinx-notfound-page`` extension to generate nice 404 pages.
+-- by :user:`humitos`
diff --git a/docs/conf.py b/docs/conf.py
@@ -202,6 +202,9 @@
 extensions += ['sphinx-favicon']
 html_static_path = ['images']  # should contain the folder with icons
 
+# Add support for nice Not Found 404 pages
+extensions += ['notfound.extension']
+
 # List of dicts with <link> HTML attributes
 # static-file points to files in the html_static_path (href is computed)
 favicons = [

diff --git a/setup.cfg b/setup.cfg
@@ -88,6 +88,7 @@ docs =
 	jaraco.packaging >= 9
 	rst.linker >= 1.9
 	jaraco.tidelift >= 1.4
+	sphinx-notfound-page==0.8.3
 
 	# local
 	pygments-github-lexers==0.0.5