deploy: 7a5ada1

diplomat-lsp/_sources/index.rst.txt

@@ -11,6 +11,7 @@ Diplomat documentation
 
    introduction/intro
    introduction/setup
+   introduction/configuration
 
 
 

diplomat-lsp/_sources/introduction/configuration.rst.txt

@@ -0,0 +1,56 @@
+Configuring Diplomat
+====================
+
+Setting up the source tree
+--------------------------
+
+When opening a folder for the first time, Diplomat will recursively scan the folder to detect 
+all source file and try to infer a source tree. 
+Without more configuration, you will have multiple top level files which is probably not what is wanted.
+
+This will probably lead to a lot of warnings and errors that may not be relevant.
+For a simple workspace, this very basic setup may be enough. 
+
+Selecting the top-level
+.......................
+
+The selection of the top-level file is made by a right click on the file in the filetree view of Visual Code.
+
+.. figure:: /img/select_top_level_dark.png
+    :figclass: only-dark
+    :align: center
+
+    Top level file selection
+
+.. figure:: /img/select_top_level_light.png
+    :figclass: only-light
+    :align: center
+
+    Top level file selection
+
+.. tip:: 
+    After changing the top-level file, it may be required to manually reindex the workspace.
+    To do so, use ``Diplomat: Reindex`` command from the command palette.
+
+Excluding files
+...............
+
+For several reason, it will be useful to remove files or even directory.
+This is done by right-clicking on the file or folder to exclude and select ``Ignore path for Diplomat LSP``.
+
+.. warning:: 
+    There is no visual feedback upon ignoring a file and there is a need to reindex (either by using the command or by saving a file).
+
+
+Saving and loading the configuration
+..................................... 
+
+Once you configured your workspace, you should save this configuration using the ``Diplomat: Save the workspace configuration from the server`` command.
+This will save all the workspace configuration into a json file in a location determined by VSCode.
+
+This configuration file should not have to be edited manually as it reflects the result of user commands.
+However, the command ``Diplomat: Open config file`` will open this file for edition in VSCode.
+
+Normally, the settings are loaded upon starting the language server.
+If the loading fails upon startup (which may happen) or if the file has been manually updated, the settings may be reloaded from the file with the command
+``Diplomat: Load the workspace configuration to the server``

diplomat-lsp/genindex.html

@@ -200,6 +200,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="introduction/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introduction/setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul>

diplomat-lsp/index.html

@@ -202,6 +202,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="introduction/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introduction/setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul>
@@ -279,6 +280,15 @@ <h1>Diplomat documentation<a class="headerlink" href="#diplomat-documentation" t
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/configuration.html">Configuring Diplomat</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction/configuration.html#setting-up-the-source-tree">Setting up the source tree</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="introduction/configuration.html#selecting-the-top-level">Selecting the top-level</a></li>
+<li class="toctree-l3"><a class="reference internal" href="introduction/configuration.html#excluding-files">Excluding files</a></li>
+<li class="toctree-l3"><a class="reference internal" href="introduction/configuration.html#saving-and-loading-the-configuration">Saving and loading the configuration</a></li>
+</ul>
+</li>
+</ul>
+</li>
 </ul>
 </div>
 <div class="toctree-wrapper compound">

diplomat-lsp/introduction/intro.html

@@ -202,6 +202,7 @@
 <ul class="current">
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul>

diplomat-lsp/introduction/setup.html

@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Development features" href="../vscode/development.html" /><link rel="prev" title="Introduction" href="intro.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Configuring Diplomat" href="configuration.html" /><link rel="prev" title="Introduction" href="intro.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2024.07.18 -->
         <title>Setup Diplomat - Diplomat 0.2.0 documentation</title>
@@ -202,6 +202,7 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul>
@@ -343,12 +344,12 @@ <h4>Language server<a class="headerlink" href="#language-server" title="Permalin
       <footer>
 
         <div class="related-pages">
-          <a class="next-page" href="../vscode/development.html">
+          <a class="next-page" href="configuration.html">
               <div class="page-info">
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">Development features</div>
+                <div class="title">Configuring Diplomat</div>
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>

diplomat-lsp/lsp/custom_lsp.html

@@ -202,6 +202,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul>

diplomat-lsp/lsp/standard_lsp.html

@@ -202,6 +202,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul>

diplomat-lsp/search.html

@@ -202,6 +202,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="introduction/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introduction/setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="introduction/configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul>

diplomat-lsp/vscode/development.html

@@ -3,7 +3,7 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Testing features" href="test.html" /><link rel="prev" title="Setup Diplomat" href="../introduction/setup.html" />
+<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Testing features" href="test.html" /><link rel="prev" title="Configuring Diplomat" href="../introduction/configuration.html" />
 
     <!-- Generated with Sphinx 7.1.2 and Furo 2024.07.18 -->
         <title>Development features - Diplomat 0.2.0 documentation</title>
@@ -202,6 +202,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul class="current">
@@ -375,14 +376,14 @@ <h2>Module instanciaton<a class="headerlink" href="#module-instanciaton" title="
               </div>
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
             </a>
-          <a class="prev-page" href="../introduction/setup.html">
+          <a class="prev-page" href="../introduction/configuration.html">
               <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
               <div class="page-info">
                 <div class="context">
                   <span>Previous</span>
                 </div>
 
-                <div class="title">Setup Diplomat</div>
+                <div class="title">Configuring Diplomat</div>
 
               </div>
             </a>

diplomat-lsp/vscode/sim_debug.html

@@ -202,6 +202,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul class="current">

diplomat-lsp/vscode/test.html

@@ -202,6 +202,7 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../introduction/setup.html">Setup Diplomat</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../introduction/configuration.html">Configuring Diplomat</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">VS Code extension</span></p>
 <ul class="current">