Merge pull request #2846 from jessica-mitchell/custom-404-docpage

Add a custom 404 page for Read the docs
nest · Jul 4, 2023 · 9e49c7e · 9e49c7e
2 parents a9aa380 + 571ccf5
commit 9e49c7e
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 0 deletions.
diff --git a/doc/htmldoc/404.rst b/doc/htmldoc/404.rst
@@ -0,0 +1,11 @@
+:orphan:
+
+404 - Page not found
+--------------------
+
+
+Sorry, it looks like the page you were looking for doesn't exist in this version or has moved.
+
+Try the search bar or the navigation sidebar.
+
+
diff --git a/doc/htmldoc/conf.py b/doc/htmldoc/conf.py
@@ -59,6 +59,7 @@
     "HoverXTooltip",
     "VersionSyncRole",
     "sphinx_copybutton",
+    "notfound.extension",
 ]
 
 autodoc_mock_imports = ["nest.pynestkernel", "nest.ll_api"]

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -23,6 +23,7 @@ seaborn==0.12.2
 sphinx==6.2.1
 sphinx_autobuild==2021.3.14
 sphinx-copybutton>=0.5.2
+sphinx-notfound-page>=0.8.3
 sphinx-design==0.4.1
 sphinx-gallery==0.13.0
 sphinx-material==0.0.35

diff --git a/environment.yml b/environment.yml
@@ -111,3 +111,4 @@ dependencies:
     - sphinx_design
     - sphinx-material
     - sphinx-copybutton
+    - sphinx-notfound-page