pw_ide: Support esbonio ReST language server

Change-Id: I1516d5b25defa5318779aa58274f120c54b9b01a Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/130310 Commit-Queue: Chad Norvell <[email protected]> Reviewed-by: Keir Mierle <[email protected]>
google · Feb 24, 2023 · 8db026a · 8db026a
1 parent 2b00ec0
commit 8db026a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 7 deletions.
diff --git a/pw_ide/docs.rst b/pw_ide/docs.rst
@@ -102,6 +102,16 @@ to the virtual environment on your system with:
 
   pw ide python --venv
 
+Docs Code Intelligence
+----------------------
+The `esbonio <https://github.com/swyddfa/esbonio>`_ language server will provide
+code intelligence for RestructuredText and Sphinx. It works well with Pigweed
+projects as long as it is pointed to Pigweed's Python virtual environment. For
+Visual Studio Code, simply install the esbonio extension, which will be
+recommended to you after setting up ``pw_ide``. Once it's installed, a prompt
+will ask if you want to automatically install esbonio in your Pigweed Python
+environment. After that, give esbonio some time to index, then you're done!
+
 Command-Line Interface Reference
 --------------------------------
 .. argparse::

diff --git a/pw_ide/py/pw_ide/vscode.py b/pw_ide/py/pw_ide/vscode.py
@@ -184,13 +184,6 @@ def _local_python_settings() -> Dict[str, Any]:
         "[proto3]": OrderedDict(
             {"editor.defaultFormatter": "zxh404.vscode-proto3"}
         ),
-        "[restructuredtext]": OrderedDict(
-            {
-                "editor.quickSuggestions": OrderedDict(
-                    {"comments": "off", "strings": "off", "other": "off"}
-                )
-            }
-        ),
     }
 )
 
@@ -277,10 +270,13 @@ def _local_python_settings() -> Dict[str, Any]:
             "msedge-dev.gnls",
             "zxh404.vscode-proto3",
             "josetr.cmake-language-support-vscode",
+            "swyddfa.esbonio",
         ],
         "unwantedRecommendations": [
             "ms-vscode.cpptools",
             "persidskiy.vscode-gnformat",
+            "lextudio.restructuredtext",
+            "trond-snekvik.simple-rst",
         ],
     }
 )