aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/api.rst
diff options
context:
space:
mode:
authorShivesh Mandalia <shivesh.mandalia@outlook.com>2020-03-03 02:36:22 +0000
committerShivesh Mandalia <shivesh.mandalia@outlook.com>2020-03-03 02:36:22 +0000
commitf18364ec6522466afbdd64bdf563a54c9e6e4db9 (patch)
tree9bee7890ee256e999327813c00f0d80cd73b2c11 /docs/source/api.rst
parentfaadd4e4eb901f7a49128b3b7e6a0a3ffbcd4664 (diff)
downloadGolemFlavor-f18364ec6522466afbdd64bdf563a54c9e6e4db9.tar.gz
GolemFlavor-f18364ec6522466afbdd64bdf563a54c9e6e4db9.zip
documentation
Diffstat (limited to 'docs/source/api.rst')
-rw-r--r--docs/source/api.rst46
1 files changed, 43 insertions, 3 deletions
diff --git a/docs/source/api.rst b/docs/source/api.rst
index c9a5f05..94a6b9e 100644
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@@ -2,6 +2,46 @@
:github_url: https://github.com/ShiveshM/GolemFlavor
-***
-API
-***
+***************
+GolemFlavor API
+***************
+
+Emcee hooks
+-----------
+.. automodule:: golemflavor.mcmc
+ :members:
+
+Enumerations
+------------
+.. automodule:: golemflavor.enums
+ :members:
+
+Flavor Functions
+----------------
+.. automodule:: golemflavor.fr
+ :members:
+
+GolemFit Hooks
+--------------
+.. automodule:: golemflavor.gf
+ :members:
+
+Likelihood
+----------
+.. automodule:: golemflavor.llh
+ :members:
+
+Miscellaneous
+-------------
+.. automodule:: golemflavor.misc
+ :members:
+
+Parameter class
+---------------
+.. automodule:: golemflavor.param
+ :members:
+
+Visualization
+-------------
+.. automodule:: golemflavor.plot
+ :members: