Try out two ways to add doc redirects for Linen links

google · Oct 1, 2024 · 3095f4d · 3095f4d
1 parent e0dafb9
commit 3095f4d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/docs_nnx/.readthedocs.yaml b/docs_nnx/.readthedocs.yaml
@@ -29,3 +29,8 @@ python:
         - all
         - testing
         - docs
+
+Type: Exact Redirect
+From URL: https://flax-nnx.readthedocs.io/en/latest/quick_start.html
+To URL: https://flax-linen.readthedocs.io/en/latest/quick_start.html
+Force Redirect: True
diff --git a/docs_nnx/guides/flax_fundamentals/flax_basics.rst b/docs_nnx/guides/flax_fundamentals/flax_basics.rst
@@ -0,0 +1,18 @@
+.. raw:: html
+
+  <!-- This is a dummy page for re-directing existing Linen guides' old links to the Linen site. -->
+  <!DOCTYPE HTML>
+  <html lang="en-US">
+      <head>
+          <meta charset="UTF-8">
+          <meta http-equiv="refresh" content="0; url=https://flax-linen.readthedocs.io/en/latest/guides/flax_fundamentals/flax_basics.html">
+          <script type="text/javascript">
+              window.location.href = "https://flax-linen.readthedocs.io/en/latest/guides/flax_fundamentals/flax_basics.html"
+          </script>
+          <title>Page Redirection</title>
+      </head>
+      <body>
+          <!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->
+          The old Flax Linen API and guides has been moved to another domain. Follow this <a href='https://flax-linen.readthedocs.io/en/latest/guides/flax_fundamentals/flax_basics.html'>link to the page.</a>.
+      </body>
+  </html>