docs: support redirects (#5301)

jina-ai · Oct 25, 2022 · 7b3f5d8 · 7b3f5d8
1 parent 0ada581
commit 7b3f5d8
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -102,6 +102,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.coverage',
     'sphinxcontrib.apidoc',
+    'sphinxcontrib.redirects',
     'sphinxarg.ext',
     'sphinx_copybutton',
     'sphinx_sitemap',
@@ -116,7 +117,7 @@
 intersphinx_mapping = {'docarray': ('https://docarray.jina.ai/', None)}
 myst_enable_extensions = ['colon_fence']
 autosummary_generate = True
-
+redirects_file = 'redirects.txt'
 # -- Custom 404 page
 
 # sphinx-notfound-page

diff --git a/docs/redirects.txt b/docs/redirects.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,6 +2,7 @@
 sphinx
 sphinx-argparse==0.3.1
 sphinxcontrib-apidoc==0.3.0
+sphinxcontrib-redirects==0.1.0
 sphinx-autodoc-typehints==1.18.3
 sphinx_copybutton
 sphinx-notfound-page==0.7.1