Docstrings and doctests (#71)

* use top level histories in pytest * docs and doctests for optimization module * docs and doctests for ksfs module * docs and doctests for histories module * docs and doctests for composition module * how to run doctests * autodoc loss_functions module * math docstrings for loss_functions * trim a docstring * docstrings and doctests for utils module * sphinx doctest extension * docs build
harrispopgen · Feb 5, 2021 · 27e3a84 · 27e3a84
1 parent 985d55a
commit 27e3a84
Show file tree

Hide file tree

Showing 92 changed files with 9,398 additions and 7,227 deletions.
diff --git a/docs/_images/notebooks_quickstart_10_0.svg b/docs/_images/notebooks_quickstart_10_0.svg
diff --git a/docs/_images/notebooks_quickstart_14_1.svg b/docs/_images/notebooks_quickstart_14_1.svg
diff --git a/docs/_images/notebooks_quickstart_18_2.svg b/docs/_images/notebooks_quickstart_18_2.svg
diff --git a/docs/_images/notebooks_quickstart_20_0.svg b/docs/_images/notebooks_quickstart_20_0.svg
diff --git a/docs/_images/notebooks_quickstart_22_0.svg b/docs/_images/notebooks_quickstart_22_0.svg
diff --git a/docs/_images/notebooks_quickstart_23_2.svg b/docs/_images/notebooks_quickstart_23_2.svg
diff --git a/docs/_images/notebooks_quickstart_24_1.svg b/docs/_images/notebooks_quickstart_24_1.svg
diff --git a/docs/_images/notebooks_quickstart_4_1.svg b/docs/_images/notebooks_quickstart_4_1.svg
diff --git a/docs/_images/notebooks_quickstart_8_0.svg b/docs/_images/notebooks_quickstart_8_0.svg
diff --git a/docs/_images/notebooks_simulation_11_1.svg b/docs/_images/notebooks_simulation_11_1.svg
diff --git a/docs/_images/notebooks_simulation_11_2.svg b/docs/_images/notebooks_simulation_11_2.svg
diff --git a/docs/_images/notebooks_simulation_15_0.svg b/docs/_images/notebooks_simulation_15_0.svg