testing bolded links, adding contributing stub

CohenLabPrinceton · Aug 16, 2020 · 3114174 · 3114174
1 parent 9d104a1
commit 3114174
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 5 deletions.
diff --git a/_docs/contributing.rst b/_docs/contributing.rst
@@ -0,0 +1,3 @@
+Contributing
+=============
+
diff --git a/_docs/index.rst b/_docs/index.rst
@@ -54,17 +54,16 @@ and inspection bottlenecks of split computer/microprocessor systems that require
 All of PVP's components are **modularly designed**, allowing them to be reconfigured and expanded for new ventilation modes and
 hardware configurations.
 
-We provide complete **API-level documentation** and an **automated testing suite** to give everyone the freedom to inspect,
+We provide complete **:ref:`API-level documentation <software_overview>`** and an **`automated testing suite <https://github.com/CohenLabPrinceton/pvp/tree/master/tests>`_** to give everyone the freedom to inspect,
 understand, and expand PVP's software framework.
 
 
+
 PVP Modules
 ------------
 
 .. raw:: html
 
-
-
     <div class="software-summary">
         <a href="gui.html"><h2>GUI</h2></a> <p>A modular GUI with intuitive controls and a clear alarm system that can be configured to control any parameter or display values from any sensor.</p>
         <a href="controller.html"><h2>Controller</h2></a> <p>... Manuel write this</p>
@@ -76,7 +75,6 @@ PVP Modules
 
 
 
-
 .. toctree::
    :hidden:
    :maxdepth: 4
@@ -127,6 +125,7 @@ PVP Modules
    :caption: Meta:
 
    Changelog <changelog/index>
+   Contributing <contributing>
    Building the Docs <buildthedocs>
    Markdown Example <example_markdown>
    Index <meta_index>
diff --git a/_docs/software_overview.rst b/_docs/software_overview.rst
@@ -1,2 +1,17 @@
+.. _software_overview:
+
 Software Overview
-==================
+==================
+
+PVP Modules
+------------
+
+.. raw:: html
+
+    <div class="software-summary">
+        <a href="gui.html"><h2>GUI</h2></a> <p>A modular GUI with intuitive controls and a clear alarm system that can be configured to control any parameter or display values from any sensor.</p>
+        <a href="controller.html"><h2>Controller</h2></a> <p>... Manuel write this</p>
+        <a href="io.html"><h2>IO</h2></a> <p>A hardware abstraction layer powered by <a href="http://abyz.me.uk/rpi/pigpio/">pigpio</a> that can read/write at [x Hz]</p>
+        <a href="alarm.html"><h2>Alarm</h2></a> <p>Define complex and responsive alarm triggering criteria with human-readable Alarm Rules</p>
+        <a href="common.html"><h2>Common</h2><a> <p>Modules that provide the API between the GUI and controller, user preferences, and other utilities</p>
+    </div>