Improved Docs

Author: harripd

.github/workflows/build_wheels.yml

@@ -1,6 +1,12 @@
-name: Build
+name: Build and Test
 
-on: [push, pull_request]
+on:
+  push: 
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   build_wheels:

.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+
+python:
+  version: 3.8
+  install:
+    - requierments: docs/source/requirements.txt
+    - method: pip
+      path: .
+    system_packages: true
+
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py

README.md

@@ -1,6 +1,6 @@
 # H2MM_C
 
-![Build and Test](https://github.com/harripd/H2MMpythonlib/actions/workflows/build_wheels.yml/badge.svg)
+[![Build and Test](https://github.com/harripd/H2MMpythonlib/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/harripd/H2MMpythonlib/actions)
 
 ## Project Desciption
 H2MM_C is a python extension module that implements the H<sup>2</sup>MM algorithm originally developed by [Pirchi et. al. J. Phys. Chem B. 2016, 120, 13065-12075](http://dx.doi.org/10.1371/journal.pone.0160716) in a highly efficent and multithreaded manner, along with functions for posterior analysis with the *Viterbi* algorithm. 

docs/source/CustomPrint.rst

@@ -8,6 +8,8 @@ Customizing Optimization Progress Display
     This can also be viewed as a Jupyter Notebook
     Downlaod :download:`H2MM_DisplayProgress.ipynb  <notebooks/H2MM_DisplayProgress.ipynb>`
 
+    The data file can be downloaded here: :download:`sample_data_3det.txt <notebooks/sample_data_3det.txt>`
+
 As always, lets get the imports and loading data out of the way:
 
 .. code-block::

docs/source/FBoundingTutorial.rst

@@ -8,6 +8,8 @@ Bounding |H2MM|
     This can also be viewed as a Jupyter Notebook
     Downlaod :download:`H2MM_Bounds_Tutorial.ipynb <notebooks/H2MM_Bounds_Tutorial.ipynb>`
 
+    The data file can be downloaded here: :download:`sample_data_3det.txt <notebooks/sample_data_3det.txt>`
+
 Let's get our obligatory imports in order, this time we'll start with the 3 detector data.
 
 .. code-block::

docs/source/FOptimizationTutorial.rst

@@ -8,6 +8,9 @@ Basic Optimizations with H2MM_C
     This can also be viewed as a Jupyter Notebook
     Downlaod :download:`H2MM_Optimization_Tutorial.ipynb  <notebooks/H2MM_Optimization_Tutorial.ipynb>`
 
+    The data files can be downloaded here: :download:`sample_data_2det.txt <notebooks/sample_data_2det.txt>` :download:`sample_data_3det.txt <notebooks/sample_data_3det.txt>`
+
+
 First let's import some standard modules:
 
 .. code-block::

docs/source/OBoundingTutorial.rst

@@ -8,6 +8,8 @@ Bounding |H2MM|
     This can also be viewed as a Jupyter Notebook
     Downlaod :download:`H2MM_Bounds_Tutorial-OOP.ipynb <notebooks/H2MM_Bounds_Tutorial-OOP.ipynb>`
 
+    The data file can be downloaded here: :download:`sample_data_3det.txt <notebooks/sample_data_3det.txt>`
+
 Let's get our obligatory imports in order, this time we'll start with the 3 detector data.
 
 .. code-block::

docs/source/OOptimizationTutorial.rst

@@ -3,6 +3,13 @@ Basic Optimizations with H2MM_C
 
 .. currentmodule:: H2MM_C
 
+.. seealso::
+
+    This can also be viewed as a Jupyter Notebook
+    Downlaod :download:`H2MM_Optimization_Tutorial-OOP.ipynb  <notebooks/H2MM_Optimization_Tutorial-OOP.ipynb>`
+
+    The data files can be downloaded here: :download:`sample_data_2det.txt <notebooks/sample_data_2det.txt>` :download:`sample_data_3det.txt <notebooks/sample_data_3det.txt>`
+
 First let's import some standard modules:
 
 .. code-block::

docs/source/SecondaryControl.rst

@@ -8,6 +8,8 @@ H2MM_C Secondary Control Features
     This can also be viewed as a Jupyter Notebook
     Downlaod :download:`H2MM_Control_Optimization.ipynb <notebooks/H2MM_Control_Optimization.ipynb>`
 
+    Download the data file here: :download:`sample_data_3det.txt <notebooks/sample_data_3det.txt>`
+
 First, our obligatory imports and loading of 3 detector data:
 
 .. code-block::

docs/source/SimTutorial.rst

@@ -8,6 +8,8 @@ Simulations Tutorial
     This can also be viewed as a Jupyter Notebook
     Downlaod :download:`H2MM_Simulation_Tutorial.ipynb <notebooks/H2MM_Simulation_Tutorial.ipynb>`
 
+    Download data file here: :download:`sample_data_3det.txt <notebooks/sample_data_3det.txt>`
+
 The other side of H2MM_C is a set of functions for producing simulated data.
 
 The simulation functions of H2MM_C are starte with :code:`sim_`.