Move userguide/keywords to deprecated/changed_keyworkds

cdce8p · May 6, 2022 · 094809b · 094809b
1 parent 3a6b7be
commit 094809b
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -129,6 +129,12 @@
     },
 }
 
+# Redirect old docs so links and references in the ecosystem don't break
+extensions += ['sphinx_reredirects']
+redirects = {
+    "userguide/keywords": "/deprecated/changed_keywords.html",
+}
+
 # Add support for inline tabs
 extensions += ['sphinx_inline_tabs']
 

diff --git a/docs/userguide/keywords.rst → docs/deprecated/changed_keywords.rst b/docs/userguide/keywords.rst → docs/deprecated/changed_keywords.rst
diff --git a/docs/deprecated/index.rst b/docs/deprecated/index.rst
@@ -13,6 +13,7 @@ objectives.
 .. toctree::
     :maxdepth: 1
 
+    changed_keywords
     python_eggs
     easy_install
     distutils/index

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
@@ -32,7 +32,6 @@ quickstart provides an overview of the new workflow.
     extension
     declarative_config
     pyproject_config
-    keywords
     commands
     functionalities_rewrite
     miscellaneous
diff --git a/docs/userguide/package_discovery.rst b/docs/userguide/package_discovery.rst
@@ -6,7 +6,7 @@ Package Discovery and Namespace Package
 
 .. note::
     a full specification for the keyword supplied to ``setup.cfg`` or
-    ``setup.py`` can be found at :doc:`keywords reference <keywords>`
+    ``setup.py`` can be found at :doc:`keywords reference </references/keywords>`
 
 .. note::
     the examples provided here are only to demonstrate the functionality

diff --git a/setup.cfg b/setup.cfg
@@ -93,6 +93,7 @@ docs =
 	pygments-github-lexers==0.0.5
 	sphinx-favicon
 	sphinx-inline-tabs
+	sphinx-reredirects
 	sphinxcontrib-towncrier
 	furo