Add information about Cocotb tests discovery

suzizecat · Aug 13, 2024 · 5054d6c · 5054d6c
1 parent f8f672f
commit 5054d6c
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 1 deletion.
diff --git a/diplomat-lsp-src/source/conf.py b/diplomat-lsp-src/source/conf.py
@@ -22,7 +22,7 @@
 author = 'Julien FAUCHER'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.1'
+release = '0.2.0'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/diplomat-lsp-src/source/img/testing_dark.png b/diplomat-lsp-src/source/img/testing_dark.png
diff --git a/diplomat-lsp-src/source/img/testing_light.png b/diplomat-lsp-src/source/img/testing_light.png
diff --git a/diplomat-lsp-src/source/index.rst b/diplomat-lsp-src/source/index.rst
@@ -18,6 +18,7 @@ Diplomat documentation
    :caption: VS Code extension
 
    vscode/development
+   vscode/test
    vscode/sim_debug
 
 .. toctree::

diff --git a/diplomat-lsp-src/source/vscode/test.rst b/diplomat-lsp-src/source/vscode/test.rst
@@ -0,0 +1,27 @@
+Testing features
+===================
+
+Cocotb tests discovery
+-----------------------
+
+Diplomat automatically discover tests from Cocotb testbenches.
+This is done by looking up Makefiles in the workspace tree and then checking if they match a cocotb makefile.
+
+The tests are then individually discovered and can be run using the built-in "Testing" pane of VS Code.
+
+
+.. figure:: /img/testing_dark.png
+    :figclass: only-dark
+    :align: center
+
+    Testing pane view
+
+.. figure:: /img/testing_light.png
+    :figclass: only-light
+    :align: center
+
+    Testing pane view
+
+.. note:: Only files named ``Makefile`` containing the line ``include $(shell cocotb-config --makefiles)/Makefile.sim`` will be analyzed.
+
+.. tip:: It is possible to select multiple tests to run and they will be lauched together.