Test Reference docs added

CDCgov · Mar 18, 2024 · b37f9b4 · b37f9b4
1 parent 15a9327
commit b37f9b4
Show file tree

Hide file tree

Showing 11 changed files with 58 additions and 2 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,10 +9,11 @@ CFA Multisignal Renewal Documentation
 Welcome, CFA wishes you a nice day!
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
    :caption: Contents:
 
    msei_reference/index
+   test_reference/index
 
 
 Indices And Tables
@@ -21,3 +22,7 @@ Indices And Tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+
+Meta Information 
+================
+
diff --git a/docs/source/msei_reference/index.rst b/docs/source/msei_reference/index.rst
@@ -2,7 +2,7 @@ MSEI Reference
 ==============
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 3
 
    observation
    regression

diff --git a/docs/source/test_reference/index.rst b/docs/source/test_reference/index.rst
@@ -0,0 +1,14 @@
+Test Reference
+==============
+
+.. toctree::
+   :maxdepth: 3
+
+   test_ar_process
+   test_first_difference_ar
+   test_logistic_susceptibility_adjustment
+   test_random_walk
+   test_process_asymptotics
+   test_transforms
+   test_regression
+   test_leslie_matrix
diff --git a/docs/source/test_reference/test_ar_process.rst b/docs/source/test_reference/test_ar_process.rst
@@ -0,0 +1,4 @@
+AR Process Testing Functions
+============================
+
+.. autofunction:: test.test_ar_process.test_ar_can_be_sampled
diff --git a/docs/source/test_reference/test_first_difference_ar.rst b/docs/source/test_reference/test_first_difference_ar.rst
@@ -0,0 +1,4 @@
+AR First Difference Testing Functions
+=====================================
+
+.. autofunction:: test.test_first_difference_ar.test_fd_ar_can_be_sampled
diff --git a/docs/source/test_reference/test_leslie_matrix.rst b/docs/source/test_reference/test_leslie_matrix.rst
@@ -0,0 +1,4 @@
+Leslie Matrix Testing Functions
+===============================
+
+.. autofunction:: test.test_leslie_matrix.test_get_leslie
diff --git a/docs/source/test_reference/test_logistic_susceptibility_adjustment.rst b/docs/source/test_reference/test_logistic_susceptibility_adjustment.rst
@@ -0,0 +1,4 @@
+Logistic Susceptibility Testing Functions
+=========================================
+
+.. autofunction:: test.test_logistic_susceptibility_adjustment.test_logistic_susceptibility_adjustment
diff --git a/docs/source/test_reference/test_process_asymptotics.rst b/docs/source/test_reference/test_process_asymptotics.rst
@@ -0,0 +1,4 @@
+Processed Asymptomatic Testing Functions
+========================================
+
+.. autofunction:: test.test_process_asymptotics.test_asymptotic_properties
diff --git a/docs/source/test_reference/test_random_walk.rst b/docs/source/test_reference/test_random_walk.rst
@@ -0,0 +1,7 @@
+Random Walk Testing Functions
+=============================
+
+.. autofunction:: test.test_random_walk.test_rw_can_be_sampled
+
+
+.. autofunction:: test.test_random_walk.test_rw_samples_correctly_distributed
diff --git a/docs/source/test_reference/test_regression.rst b/docs/source/test_reference/test_regression.rst
@@ -0,0 +1,4 @@
+Regression Testing Functions
+============================
+
+.. autofunction:: test.test_regression.test_glm_prediction
diff --git a/docs/source/test_reference/test_transforms.rst b/docs/source/test_reference/test_transforms.rst
@@ -0,0 +1,6 @@
+Transforms Testing Functions
+============================
+
+.. autofunction:: test.test_transforms.generic_inversion_test
+
+.. autofunction:: test.test_transforms.test_invert_dists