docs: redirect support

Author: nedbat

.github/workflows/quality.yml

@@ -133,6 +133,11 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: "Fetch origin/main"
+        # rediraffe needs to compare to origin/main
+        run: |
+          git fetch origin main --depth=1
+
       - name: "Install Python"
         uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:

doc/conf.py

@@ -39,6 +39,7 @@
     "sphinx.ext.intersphinx",
     "sphinxcontrib.restbuilder",
     "sphinx.ext.napoleon",
+    "sphinxext.rediraffe",
     "sphinx_code_tabs",
     "sphinx_rtd_theme",
 ]
@@ -125,6 +126,11 @@
     "python": ("https://docs.python.org/3", None),
 }
 
+rediraffe_branch = "origin/master"
+rediraffe_redirects = {
+    "cmd.rst": "commands/index.rst",
+}
+
 nitpick_ignore = [
     ("py:class", "DefaultValue"),
     ("py:class", "FilePath"),

doc/requirements.in

@@ -17,3 +17,4 @@ sphinx-code-tabs
 sphinx-lint
 sphinxcontrib-restbuilder
 sphinxcontrib-spelling
+git+https://github.com/nedbat/sphinxext-rediraffe@nedbat/bug-58

tox.ini

@@ -86,6 +86,7 @@ commands =
     doc8 -q --ignore-path 'doc/_*' doc CHANGES.rst README.rst
     sphinx-lint doc CHANGES.rst README.rst
     sphinx-build -b html -aEnqW doc doc/_build/html
+    sphinx-build -b rediraffecheckdiff doc/ doc/_build/html
     rst2html --verbose --strict README.rst doc/_build/README.html
     - sphinx-build -b html -b linkcheck -aEnq doc doc/_build/html
     - sphinx-build -b html -b linkcheck -aEnQW doc doc/_build/html