diff options
| author | Gertjan van den Burg <gertjanvandenburg@gmail.com> | 2017-12-13 14:36:16 -0500 |
|---|---|---|
| committer | Gertjan van den Burg <gertjanvandenburg@gmail.com> | 2017-12-13 14:36:16 -0500 |
| commit | 1be8420e868aa898da512aead3160d48867b07ed (patch) | |
| tree | 79a0d90d79756d18a293e9f1c33fd56786de6724 /docs | |
| parent | amend last commit (diff) | |
| download | pygensvm-1be8420e868aa898da512aead3160d48867b07ed.tar.gz pygensvm-1be8420e868aa898da512aead3160d48867b07ed.zip | |
various documentation updates
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cls_gensvm.rst | 2 | ||||
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/index.rst | 7 |
3 files changed, 6 insertions, 5 deletions
diff --git a/docs/cls_gensvm.rst b/docs/cls_gensvm.rst index 082df8f..4e67631 100644 --- a/docs/cls_gensvm.rst +++ b/docs/cls_gensvm.rst @@ -10,7 +10,7 @@ errors. It is this flexibility that makes it perform well on diverse datasets. - The :func:`.~GenSVM.fit` and :func:`~GenSVM.predict` methods of this class + The :func:`~GenSVM.fit` and :func:`~GenSVM.predict` methods of this class use the GenSVM C library for the actual computations. :param p: Parameter for the L_p norm of the loss function (1.0 <= p <= 2.0) diff --git a/docs/conf.py b/docs/conf.py index 8a02df3..e3eb6b9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -136,7 +136,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # further. For a list of options available for each theme, see the # documentation. # -# html_theme_options = {} +html_theme_options = {'collapse_navigation': True} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/index.rst b/docs/index.rst index 7f539b8..7a28f0e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,19 +3,20 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. toctree:: .. include:: ../README.rst Classes -======= +------- GenSVM ------- +^^^^^^ .. include:: ./cls_gensvm.rst GenSVMGridSearchCV ------------------- +^^^^^^^^^^^^^^^^^^ .. include:: ./cls_gridsearch.rst |