DEV: Fixed Un-responsive live-preview in gitpod. (numpy#21250)

* Replaced existing obselete dependencies. Added Install "esbonio". * Update vscode config * DEV: Block breathe "4.33.0" version of breathe which conflicts with sphinx.ext.graphviz Co-authored-by: Ross Barnowski <[email protected]>
hdlee · Mar 30, 2022 · 41cf10d · 41cf10d
1 parent beb5ded
commit 41cf10d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/.gitpod.yml b/.gitpod.yml
@@ -19,6 +19,8 @@ tasks:
       echo "📖 Building docs 📖 "
       cd doc
       make html
+      echo "Installing dependencies for documentation Live-Preview"
+      pip install esbonio
       echo "✨ Pre-build complete! You can close this terminal ✨ "
 
 # --------------------------------------------------------

diff --git a/environment.yml b/environment.yml
@@ -29,7 +29,8 @@ dependencies:
   - pandas
   - matplotlib
   - pydata-sphinx-theme=0.7.2
-  - breathe
+  # NOTE: breathe 4.33.0 collides with sphinx.ext.graphviz
+  - breathe!=4.33.0
   # For linting
   - pycodestyle=2.7.0
   - gitpython

diff --git a/tools/gitpod/settings.json b/tools/gitpod/settings.json
@@ -1,9 +1,8 @@
 {
-    "restructuredtext.languageServer.disabled": true,
-    "restructuredtext.builtDocumentationPath": "${workspaceRoot}/doc/build/html",
-    "restructuredtext.confPath": "",
     "restructuredtext.updateOnTextChanged": "true",
     "restructuredtext.updateDelay": 300,
-    "restructuredtext.linter.disabled": true,
-    "python.defaultInterpreterPath": "/home/gitpod/mambaforge3/envs/numpy-dev/bin/python"
+    "restructuredtext.linter.disabledLinters": ["doc8","rst-lint", "rstcheck"],
+    "python.defaultInterpreterPath": "/home/gitpod/mambaforge3/envs/numpy-dev/bin/python",
+    "esbonio.sphinx.buildDir": "${workspaceRoot}/doc/build/html",
+    "esbonio.sphinx.confDir": ""
 }