Update documentation

lan13005 · Oct 26, 2023 · 8f65210 · 8f65210
1 parent 9a4930b
commit 8f65210
Show file tree

Hide file tree

Showing 21 changed files with 328 additions and 3,542 deletions.
diff --git a/_autosummary/PlotGen.html b/_autosummary/PlotGen.html
diff --git a/_autosummary/PlotGenRDF.html b/_autosummary/PlotGenRDF.html
diff --git a/_autosummary/extract_ff.html b/_autosummary/extract_ff.html
diff --git a/_autosummary/fit.html b/_autosummary/fit.html
diff --git a/_autosummary/mcmc.html b/_autosummary/mcmc.html
diff --git a/_autosummary/mcmcOptimalMoves.html b/_autosummary/mcmcOptimalMoves.html
diff --git a/_sources/_autosummary/PlotGen.rst b/_sources/_autosummary/PlotGen.rst
diff --git a/_sources/_autosummary/PlotGenRDF.rst b/_sources/_autosummary/PlotGenRDF.rst
diff --git a/_sources/_autosummary/extract_ff.rst b/_sources/_autosummary/extract_ff.rst
diff --git a/_sources/_autosummary/fit.rst b/_sources/_autosummary/fit.rst
diff --git a/_sources/_autosummary/mcmc.rst b/_sources/_autosummary/mcmc.rst
diff --git a/_sources/_autosummary/mcmcOptimalMoves.rst b/_sources/_autosummary/mcmcOptimalMoves.rst
diff --git a/_sources/api.rst b/_sources/api.rst
@@ -1,4 +1,30 @@
+.. autosummary::
+   :toctree: _autosummary
+   :template: autosummary/module.rst
+
 Detailed API documentation
 ==========================
 
+fit
+---
+.. autofunction:: fit.performFit
+.. autofunction:: fit.runFits
+
+mcmc
+----
+.. autofunction:: mcmc.LogProb
+.. autofunction:: mcmc.createMovesMixtureFromDict
+.. autofunction:: mcmc.perform_mcmc
+.. autofunction:: mcmc.draw_corner
+
+extract_ff
+----------
 .. autofunction:: extract_ff.extract_ff
+
+PlotGen
+-------
+.. autofunction:: PlotGen.PlotGen
+
+PlotGenRDF
+----------
+.. autofunction:: PlotGenRDF.draw_histograms
diff --git a/_sources/_autosummary/modules.rst → _sources/templates/autosummary/module.rst b/_sources/_autosummary/modules.rst → _sources/templates/autosummary/module.rst
@@ -3,5 +3,5 @@
 
 .. automodule:: {{ name }}
    :members:
-   :inherited-members:
+   :undoc-members:
    :show-inheritance: