diff --git a/doc/source/dev/debugging_galaxy.md b/doc/source/dev/debugging_galaxy.md index 0c5e340b69c..281bb09693d 100644 --- a/doc/source/dev/debugging_galaxy.md +++ b/doc/source/dev/debugging_galaxy.md @@ -3,10 +3,10 @@ ## Debugging Galaxy in VS Code -The following instructions assume that you have cloned your Galaxy fork into ~/galaxy directory and have created a VS code workspace per instructions [here](./debugging_tests.md) +The following instructions assume that you have cloned your Galaxy fork into the `~/galaxy` directory and have created a VS Code workspace per instructions [here](./debugging_tests.md) 1. Download this [ini](https://raw.githubusercontent.com/galaxyproject/galaxy/release_17.09/config/galaxy.ini.sample) file and and save it as ~/galaxy/config/galaxy.ini.old -2. Add the following code snippet to ~/galaxy/.vscode/launch.json (Create the file if it does not already exist) +2. Add the following code snippet to `~/galaxy/.vscode/launch.json` (create the file if it does not already exist) ``` { "version": "0.2.0", @@ -34,8 +34,8 @@ The following instructions assume that you have cloned your Galaxy fork into ~/g } ``` -3. Re-start VS code -4. Add a break point some where in your code +3. Re-start VS Code +4. Add a breakpoint somewhere in your code 5. Select Run and Debug on Activity Bar, on the far left hand side. In the RUN AND DEBUG drop down, select Galaxy debug (galaxy), and click the Start Debugging button (green arrow) 6. Galaxy should stop right on the break point you added. -7. Enjoy your debugging session :-) \ No newline at end of file +7. Enjoy your debugging session :-) diff --git a/doc/source/dev/debugging_tests.md b/doc/source/dev/debugging_tests.md index 1608c9bec7c..97c27cb120e 100644 --- a/doc/source/dev/debugging_tests.md +++ b/doc/source/dev/debugging_tests.md @@ -5,9 +5,9 @@ The following instructions assume that you have cloned your Galaxy fork into ~/galaxy directory. 1. Start VS Code -2. Create a VS Code workspace by selecting 'File -> Add Folder to Workspace...' from menu and adding ~/galaxy directory -3. Optionally, save the workspace by selecting 'File -> Save Workspace As...' and save as 'galaxy.code-workspace' in ~/galaxy directory -2. Add the following snippet to ~/galaxy/.vscode/settings.json (Create the file if it does not already exist) +2. Create a VS Code workspace by selecting 'File -> Add Folder to Workspace...' from menu and adding the `~/galaxy` directory +3. Optionally, save the workspace by selecting 'File -> Save Workspace As...' and save as 'galaxy.code-workspace' in the `~/galaxy` directory +2. Add the following snippet to `~/galaxy/.vscode/settings.json` (create the file if it does not already exist) ``` { "python.testing.unittestEnabled": false, @@ -25,7 +25,7 @@ The following instructions assume that you have cloned your Galaxy fork into ~/g } ``` 3. Re-start VS Code -4. Select Test on Activity Bar, on the far left hand side. You should see unit and integration tests under 'Python' (As shown in image below). It may take a few seconds for the tests to load up. If they did not, click the 'Discover Tests' icon and wait for tests to load. +4. Select Test on Activity Bar, on the far left hand side. You should see unit and integration tests under 'Python' (as shown in the image below). It may take a few seconds for the tests to load up. If they do not, click the 'Discover Tests' icon and wait for the tests to load. ![VS Code Tests](tests.png) 5. Expand integration/unit tests, select a test to display its source code in editor, add a breakpoint, and start the debugger by clicking on the debug icon (next to test name) -6. Enjoy your debugging session :-) \ No newline at end of file +6. Enjoy your debugging session :-)