From ec068bb2b68de51b6b5da923f8bee5fda86a6d2f Mon Sep 17 00:00:00 2001 From: peteGSX <97784652+peteGSX@users.noreply.github.com> Date: Thu, 5 Dec 2024 07:30:35 +1000 Subject: [PATCH] Doco updated --- docs/tests.rst | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/tests.rst b/docs/tests.rst index 36261a2..b88619c 100644 --- a/docs/tests.rst +++ b/docs/tests.rst @@ -3,12 +3,6 @@ Library Tests ============= -.. sidebar:: - - .. contents:: On this page - :depth: 2 - :local: - Courtesy of Vincent Hamp, the |EX-NCL| has unit tests that can be run locally as well automatically being run as a GitHub action when pushing to the main branch (see tests.yml in the repository). These tests are written using GoogleTest which allows for mocking as well as testing. @@ -21,13 +15,13 @@ If you are using a Windows PC for the tests, it is best to utilise Windows Subsy For Ubuntu, install the required packages with: -.. codeblock:: +.. code-block:: sudo apt install build-essential doxygen cmake graphviz Once these packages are installed, running the tests is pretty simple: -.. codeblock:: +.. code-block:: cd /DCCEXProtocol cmake -Bbuild