Test redirects

Author: SailReal

.github/workflows/deploy.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: '3.13' 
-      - run: pip install sphinx sphinx_rtd_theme
+      - run: pip install sphinx sphinx_rtd_theme sphinx-reredirects
       - run: make gh-pages
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

Dockerfile

@@ -1,3 +1,3 @@
 FROM python:3.13-alpine
 
-RUN pip install --no-cache-dir sphinx sphinx_rtd_theme sphinx-autobuild
+RUN pip install --no-cache-dir sphinx sphinx_rtd_theme sphinx-autobuild sphinx-reredirects

Makefile

@@ -18,6 +18,15 @@ livehtml:
 
 gh-pages:
 	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" $(BUILDDIR)/html/en/latest $(SPHINXOPTS)
+	# Ensure Jekyll is enabled with correct YAML formatting
+	printf -- "plugins:\n  - jekyll-redirect-from\n" > $(BUILDDIR)/html/_config.yml
+	# Create redirect for root to /en/latest/
+	printf -- "---\nredirect_to: /en/latest/\n---\n" > $(BUILDDIR)/html/index.md
+	# Create redirect for /en/ to /en/latest/
+	printf -- "---\nredirect_to: /en/latest/\n---\n" > $(BUILDDIR)/html/en/index.md
+	# Ensure GitHub Pages processes Jekyll
+	rm -f $(BUILDDIR)/html/.nojekyll
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

source/conf.py

@@ -42,7 +42,8 @@
 # ones.
 #
 extensions = [
-    'sphinx.ext.todo'
+    'sphinx.ext.todo',
+    'sphinx_reredirects'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -121,6 +122,18 @@
 
 html_favicon = 'img/favicon.ico'
 
+redirects = {
+     "hub/setup/requirements/index": "/hub/deployment.html#hardware-requirements",
+     "hub/setup/billing/index": "/hub/license.html",
+     "hub/setup/keycloak-administration/index": "/hub/user-group-management.html",
+     "hub/setup/index": "/hub/deployment.html",
+     "hub/access-vault/unlocking-a-vault/4.-vault-unlocked/index": "/hub/access-vault/unlocking-a-vault/vault-unlocked.html",
+     "hub/access-vault/unlocking-a-vault/3.-add-device/index": "/hub/access-vault/unlocking-a-vault/add-device.html",
+     "hub/access-vault/unlocking-a-vault/2.-authenticate/index": "/hub/access-vault/unlocking-a-vault/authenticate.html",
+     "hub/access-vault/unlocking-a-vault/1.-click-unlock/index": "/hub/access-vault/unlocking-a-vault/click-unlock.html",
+     "desktop/vault-mounting/index": "/desktop/volume-type.html"
+}
+
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.