Merge pull request #111 from microbiomedata/86-implement-custom-error…

…-404-page-for-github-pages

Implement Sphinx-themed Error 404 page using Sphinx extension

content/home/requirements.txt

@@ -2,6 +2,10 @@ myst-parser
 sphinx_markdown_tables
 sphinx_rtd_theme
 
-# Sphinx plugin that handles redirects.
+# Sphinx extension that handles redirects.
 # Reference: https://pypi.org/project/sphinx-reredirects/
 sphinx-reredirects
+
+# Sphinx extension that creates a `404.html` page in which static assets are properly referenced.
+# Reference: https://sphinx-notfound-page.readthedocs.io
+sphinx-notfound-page==1.0.4

content/home/src/conf.py

@@ -32,9 +32,10 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-   'myst_parser',
-   'sphinx_markdown_tables',
-   'sphinx_reredirects',
+    'myst_parser',
+    'sphinx_markdown_tables',
+    'sphinx_reredirects',
+    'notfound.extension',
 ]
 
 # source_suffix = '.rst'
@@ -97,6 +98,16 @@
     "reference/metadata/*": "https://w3id.org/nmdc/nmdc",
 }
 
+# -- Sphinx Not Found Page extension --------------------
+#
+# Reference: https://sphinx-notfound-page.readthedocs.io/en/latest/configuration.html
+#
+notfound_urls_prefix = None
+notfound_context = {
+    "title": "Page Not Found",
+    "body": "<h1>Page Not Found</h1>\n\nWe failed to find a page at that address.",
+}
+
 # -- Sphinx Read The Docs Theme -------------------------
 #
 # Configure "Edit on GitHub" links.

content/legacy_home/requirements.txt

@@ -2,6 +2,6 @@ myst-parser
 sphinx_markdown_tables
 sphinx_rtd_theme
 
-# Sphinx plugin that handles redirects.
+# Sphinx extension that handles redirects.
 # Reference: https://pypi.org/project/sphinx-reredirects/
 sphinx-reredirects