Merge pull request #226 from mautic/fix-gitpod-vale-integration

Fix the Gitpod and Vale integrations

Author: RCheesley

.gitpod.Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.11
 
 # Don't update to a higher version until this issue has been fixed: https://github.com/errata-ai/vale/issues/528
 # Please keep version in sync with the version in .github/workflows/linting.yml for a consistent experience
-ENV VALE_VERSION=2.29.2
+ENV VALE_VERSION=3.7.1
 
 WORKDIR /workspace
 

.gitpod.yml

@@ -1,6 +1,5 @@
-# Since Gitpod doesn't support caching custom Dockerfiles yet, we temporarily
-# use this once which has Python 3.9 and Vale preinstalled.
-image: dennisameling/python-vale:latest
+image: 
+  file: .gitpod.Dockerfile
 
 tasks:
   - before: pip install -r docs/requirements.txt
@@ -9,7 +8,6 @@ tasks:
 vscode:
   extensions:
     - ms-python.python
-    - lextudio.restructuredtext
-    - errata-ai.vale-server
+    - [email protected] # See https://github.com/mautic/user-documentation/pull/334#issuecomment-2405922370 before upgrading.    - errata-ai.vale-server
     - eamodio.gitlens
     - trond-snekvik.simple-rst

.vscode/settings.json

@@ -5,5 +5,8 @@
     "esbonio.sphinx.confDir": "${workspaceFolder}/docs",
     "restructuredtext.pythonRecommendation.disabled": true,
     "restructuredtext.preview.name": "sphinx",
+    "esbonio.sphinx.pythonCommand": "python3",
+    "esbonio.sphinx.buildCommand": "sphinx-build",
+    "esbonio.logging.level": "debug",
     "gitlens.showWhatsNewAfterUpgrades": false
 }

docs/requirements.txt

@@ -1,12 +1,12 @@
 # File: docs/requirements.txt
 
 # Defining the exact version will make sure things don't break
-sphinx==6.2.1
-sphinx_rtd_theme==1.2.0
+sphinx==8.0.2
+sphinx_rtd_theme==3.0.0
 readthedocs-sphinx-search==0.3.2
-rstcheck==6.1.1
-myst-parser==1.0.0 
-linkify-it-py==2.0.0
-esbonio==0.16.4
-attrs==22.2.0
+rstcheck==6.2.4
+myst-parser==4.0.0 
+linkify-it-py==2.0.3
+esbonio==0.16.5
+attrs==24.2.0