Merge pull request #69 from cryptomator/gh-playground

Move to GitHub Pages

Author: SailReal

.github/workflows/deploy.yml

@@ -17,13 +17,13 @@ jobs:
         uses: actions/configure-pages@v5
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.13' 
-      - run: pip install sphinx sphinx_rtd_theme
-      - run: make gh-pages
+          python-version: '3.12' 
+      - run: pip install sphinx sphinx_rtd_theme sphinx-reredirects
+      - run: make dirhtml
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: 'build/html'
+          path: 'build/dirhtml'
 
   # DEPLOY
   deploy:

Dockerfile

@@ -1,3 +1,3 @@
-FROM python:3.13-alpine
+FROM python:3.12-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

@@ -16,8 +16,6 @@ help:
 livehtml:
 	sphinx-autobuild -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
 
-gh-pages:
-	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" $(BUILDDIR)/html/en/latest $(SPHINXOPTS)
 # 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/_templates/footer.html

@@ -0,0 +1,7 @@
+{# _templates/footer.html #}
+{% extends "!footer.html" %}
+
+{% block extrafooter %}
+    <a href="https://cryptomator.org/impressum/" target="_blank">Impressum</a> • <a href="https://cryptomator.org/privacy/" target="_blank">Privacy Policy</a>
+{% endblock %}
+

source/_templates/layout.html

@@ -0,0 +1,6 @@
+ {% extends "!layout.html" %}
+
+ {%- block extrahead %}
+  <script defer data-domain="docs.cryptomator.org" src="https://plausible.skymatic.de/js/script.file-downloads.outbound-links.js" integrity="sha384-+tt0STxxWB96REUfXF1ykJzPEC5cT+TVotVR/JnYqAP04zxND4o8a0JcHg+aq46t" crossorigin="anonymous"></script>
+ {% endblock %}
+

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,20 @@
 
 html_favicon = 'img/favicon.ico'
 
+html_show_sphinx = False
+
+redirects = {
+     "hub/setup/requirements": "/hub/deployment#hardware-requirements",
+     "hub/setup/billing": "/hub/license",
+     "hub/setup/keycloak-administration": "/hub/user-group-management",
+     "hub/setup": "/hub/deployment",
+     "hub/access-vault/unlocking-a-vault/4.-vault-unlocked": "/hub/access-vault/unlocking-a-vault/vault-unlocked",
+     "hub/access-vault/unlocking-a-vault/3.-add-device": "/hub/access-vault/unlocking-a-vault/add-device",
+     "hub/access-vault/unlocking-a-vault/2.-authenticate": "/hub/access-vault/unlocking-a-vault/authenticate",
+     "hub/access-vault/unlocking-a-vault/1.-click-unlock": "/hub/access-vault/unlocking-a-vault/click-unlock",
+     "desktop/vault-mounting": "/desktop/volume-type"
+}
+
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.