Merge branch 'topic/doc' into 'master'

Reorganize documentation in ALS repostory

See merge request eng/ide/ada_language_server!2089

Author: AnthonyLeonardoGracio

README.md

@@ -3,7 +3,7 @@
 
 This small tutorial will help you to create a workspace-specific environment, allowing you to set and/or modify environment variables for your project (e.g: put the needed toolchain in front of your `PATH`).
 
-This is particularly useful when working on [remote machines](Working-on-a-remote-machine) in order 
+This is particularly useful when working on [remote machines](Working-on-a-remote-machine) in order
 to avoid modifying the environment globally just to work on a given project.
 
 ## Prerequisites
@@ -23,33 +23,33 @@ Extensions view (`Ctrl+Shift+X`).
 
 Basically you just need to specify your environment variables and their associated values via the `terminal.integrated.env.*` VS Code settings in your workspace file (or your `settings.json` file), like in the following example:
 
-```
-	// Set a workspace-specific environment for OSX platforms.
-	"terminal.integrated.env.osx": {
-	        //  Set MAIN_NUMBER scenario variable to MAIN_2 directly from the environment
-		"MAIN_NUMBER": "MAIN_2",
+```json
+ // Set a workspace-specific environment for OSX platforms.
+ "terminal.integrated.env.osx": {
+         //  Set MAIN_NUMBER scenario variable to MAIN_2 directly from the environment
+  "MAIN_NUMBER": "MAIN_2",
 
                 //  Set custom GPR_PROJECT_PATH
-		"GPR_PROJECT_PATH": "${workspaceFolder}/imported:${env:GPR_PROJECT_PATH}:"
+  "GPR_PROJECT_PATH": "${workspaceFolder}/imported:${env:GPR_PROJECT_PATH}:"
         },
 
-	// Set a workspace-specific environment for Linux platforms.
-	"terminal.integrated.env.linux": {
-	        //  Set MAIN_NUMBER scenario variable to MAIN_2 directly from the environment
-		"MAIN_NUMBER": "MAIN_2",
+ // Set a workspace-specific environment for Linux platforms.
+ "terminal.integrated.env.linux": {
+         //  Set MAIN_NUMBER scenario variable to MAIN_2 directly from the environment
+  "MAIN_NUMBER": "MAIN_2",
 
                 //  Set custom GPR_PROJECT_PATH
-		"GPR_PROJECT_PATH": "${workspaceFolder}/imported:${env:GPR_PROJECT_PATH}:"
+  "GPR_PROJECT_PATH": "${workspaceFolder}/imported:${env:GPR_PROJECT_PATH}:"
         },
 
-	// Set a workspace-specific environment for Windows
-	"terminal.integrated.env.windows": {
-		//  Set MAIN_NUMBER scenario variable to MAIN_2 directly from the environment
-		"MAIN_NUMBER": "MAIN_2",
+ // Set a workspace-specific environment for Windows
+ "terminal.integrated.env.windows": {
+  //  Set MAIN_NUMBER scenario variable to MAIN_2 directly from the environment
+  "MAIN_NUMBER": "MAIN_2",
 
                 //  Set custom GPR_PROJECT_PATH
-		"GPR_PROJECT_PATH": "${workspaceFolder}\\imported;${env:GPR_PROJECT_PATH}:"
-	}
+  "GPR_PROJECT_PATH": "${workspaceFolder}\\imported;${env:GPR_PROJECT_PATH}:"
+ }
 ```
 
 ## Example

doc/Set-workspace-specific-environment-variables.md

@@ -6,7 +6,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "Ada & SPARK extension for VS Code"
+project = "Ada & SPARK VS Code Extension User's Guide"
 project_copyright = "2024-2025, AdaCore"
 author = "AdaCore"
 

integration/vscode/ada/ShowGraphDoc.md renamed to doc/ShowGraphDoc.md

@@ -1,18 +1,20 @@
-.. Ada & SPARK extension for VS Code documentation master file, created by
+.. Ada & SPARK VS Code Extension User's Guide master file, created by
    sphinx-quickstart on Thu Dec 26 19:26:17 2024.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Ada & SPARK extension for VS Code documentation
-===============================================
+Ada & SPARK VS Code Extension User's Guide
+==========================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+
+   User's Guide <vscode-ug.md>
    Tutorial: Using Ada in VS Code <Getting-Started.md>
-   refactoring_tools
-   settings
-   traces
-   tips_and_tricks
-   Protocol extensions <extensions.md>
+   Refactoring Tools <refactoring_tools.md>
+   Tips and Tricks <tips_and_tricks.rst>
+   Ada Language Server Settings <settings.md>
+   ALS Traces <traces.md>
+   Language Server Protocol Extensions <extensions.md>

doc/conf.py

@@ -106,7 +106,7 @@ Settings understood by the Ada Language Server itself, independently from the LS
 * [defaultCharset](#defaultcharset)
 * [relocateBuildTree](#relocatebuildtree)
 * [rootDir](#rootdir)
-* [enableDiagnostics](#enableddiagnostics)
+* [enableDiagnostics](#enablediagnostics)
 * [adaFileDiagnostics](#adafilediagnostics)
 * [gprFileDiagnostics](#gprfilediagnostics)
 * [sourceInfoDiagnostics](#sourceinfodiagnostics)

doc/index.rst

@@ -9,4 +9,4 @@ Tips and tricks
    Custom-colors-in-VS-Code
    Project-file-editing
    Set-workspace-specific-environment-variables
-   Working-on-a-remote-machine.md
+   Working-on-a-remote-machine.md