Merge pull request #62 from microbiomedata/60-hackathon-replace-obsol…

…ete-schema-documentation-with-http-redirect-to-latest-docs

Redirect old schema docs pages to `github.io` site

docs/conf.py

@@ -33,7 +33,8 @@
 # ones.
 extensions = [
    'myst_parser',
-   'sphinx_markdown_tables'
+   'sphinx_markdown_tables',
+   'sphinx_reredirects'
 ]
 
 # source_suffix = '.rst'
@@ -66,3 +67,13 @@
     'css/custom.css',
 ]
 html_logo = "_static/images/nmdc-logo-bg-white.png"
+
+# -- Redirects ------------------------------------------
+
+# Redirect old schema documentation URLs to the schema documentation
+# that is automatically kept in sync with the schema.
+# Reference: https://pypi.org/project/sphinx-reredirects/
+redirects = {
+    "reference/metadata/xylene": "https://w3id.org/nmdc/xylene",  # the latter redirects to: https://microbiomedata.github.io/nmdc-schema/xylene/
+    "reference/metadata/*": "https://w3id.org/nmdc/nmdc",
+}

docs/requirements.txt

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