aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2017-12-12 20:19:12 -0500
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2017-12-12 20:19:12 -0500
commit7d255c08c589a443aa72ff247b46022204a2ef22 (patch)
tree68c8f872966852d5627cef748da05612f693e4ef /docs/index.rst
parentadded gridsearch and extended gensvm class (diff)
downloadpygensvm-7d255c08c589a443aa72ff247b46022204a2ef22.tar.gz
pygensvm-7d255c08c589a443aa72ff247b46022204a2ef22.zip
added documentation
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..d8f8425
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,25 @@
+.. GenSVM documentation master file, created by
+ sphinx-quickstart on Tue Sep 26 00:11:33 2017.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+
+.. include:: ../README.rst
+
+Classes
+=======
+
+The complete documentation of the available GenSVM classes is presented below.
+
+GenSVM
+------
+
+.. autoclass:: gensvm.core.GenSVM
+
+GenSVMGridSearchCV
+------------------
+
+.. autoclass:: gensvm.gridsearch.GenSVMGridSearchCV
+
+
+.. include:: ../CHANGELOG.rst