diff --git a/docs/source/index.rst b/docs/source/index.rst index d93c9dc3..e09ae0a2 100644 --- 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 index cf6e4cca..558eae66 100644 --- 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 new file mode 100644 index 00000000..f27b04cc --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/source/test_reference/test_ar_process.rst b/docs/source/test_reference/test_ar_process.rst new file mode 100644 index 00000000..148e00af --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/source/test_reference/test_first_difference_ar.rst b/docs/source/test_reference/test_first_difference_ar.rst new file mode 100644 index 00000000..dbbcc368 --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/source/test_reference/test_leslie_matrix.rst b/docs/source/test_reference/test_leslie_matrix.rst new file mode 100644 index 00000000..c3bbad7c --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/source/test_reference/test_logistic_susceptibility_adjustment.rst b/docs/source/test_reference/test_logistic_susceptibility_adjustment.rst new file mode 100644 index 00000000..970b16b0 --- /dev/null +++ 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 new file mode 100644 index 00000000..7595f5b8 --- /dev/null +++ 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 new file mode 100644 index 00000000..1be03065 --- /dev/null +++ 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 new file mode 100644 index 00000000..07910bc7 --- /dev/null +++ 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 new file mode 100644 index 00000000..169262d4 --- /dev/null +++ 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 \ No newline at end of file