summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-05-06 12:46:54 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-05-06 12:46:54 +0100
commit094809b515b38940a8cd015633d815ec0f18b83d (patch)
treeaa983d7029fdf5026bf08150beeeb2320ad037a7 /docs
parent3a6b7be2b5e13e279c23ced23b750eb1033b968a (diff)
downloadpython-setuptools-git-094809b515b38940a8cd015633d815ec0f18b83d.tar.gz
Move userguide/keywords to deprecated/changed_keyworkds
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py6
-rw-r--r--docs/deprecated/changed_keywords.rst (renamed from docs/userguide/keywords.rst)0
-rw-r--r--docs/deprecated/index.rst1
-rw-r--r--docs/userguide/index.rst1
-rw-r--r--docs/userguide/package_discovery.rst2
5 files changed, 8 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 4ebb521c..1023539c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -129,6 +129,12 @@ html_theme_options = {
},
}
+# 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 b/docs/deprecated/changed_keywords.rst
index ba9a0df5..ba9a0df5 100644
--- a/docs/userguide/keywords.rst
+++ b/docs/deprecated/changed_keywords.rst
diff --git a/docs/deprecated/index.rst b/docs/deprecated/index.rst
index 59fc7bef..8169b3b7 100644
--- 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
index 49655acd..74e9b1e4 100644
--- 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
index 38119bc6..0854a709 100644
--- 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