diff --git a/.gitpod.yml b/.gitpod.yml index c46752f102b2..096483fd6316 100644 --- 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 index f2be74f62b1f..922fb55dca1f 100644 --- 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 index ea0775f68022..50296336dde4 100644 --- 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": "" } \ No newline at end of file