add coverage plot

hlefebvr · Jan 22, 2025 · d5145dc · d5145dc
1 parent 55ae17f
commit d5145dc
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 5 deletions.
diff --git a/docs/developer_guide/build-the-doc.rst b/docs/developer_guide/build-the-doc.rst
@@ -1,8 +1,8 @@
 .. highlight:: sh
 .. _dev_build_the_doc:
 
-Build the doc!
-==============
+Build the Documentation
+========================
 
 This page explains how to build the documentation on a local machine.
 

diff --git a/docs/developer_guide/index.rst b/docs/developer_guide/index.rst
@@ -1,7 +1,29 @@
 .. _dev:
 
-Developer guide
-===============
+Developers
+==========
+
+Unit Tests and Integration
+--------------------------
+
+idol is tested using :code:`Catch2`. Currently, the level of testing is not sufficient, but we are working on it.
+
+Here is a grid plot of the code coverage:
+
+.. image:: https://codecov.io/gh/hlefebvr/idol/graphs/tree.svg?token=BWMH5522QP
+    :align: center
+
+*Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.* (`see codecov <https://app.codecov.io>`_)
+
+For more information on how to run the tests, please refer to the :ref:`tests` page.
+
+Building the Documentation
+--------------------------
+
+The documentation is built using `doxygen`_ and a bunch of other tools. For more information, please refer to the :ref:`dev_build_the_doc` page.
+
+Related Pages
+-------------
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/developer_guide/tests.rst b/docs/developer_guide/tests.rst
@@ -1,6 +1,6 @@
 .. _tests:
 
-Unit and integration tests
+Unit and Integration Tests
 ==========================
 
 This page explains how to build the unit and integration tests on a local machine.