diff options
| author | Gertjan van den Burg <gertjanvandenburg@gmail.com> | 2020-03-06 17:22:39 +0000 |
|---|---|---|
| committer | Gertjan van den Burg <gertjanvandenburg@gmail.com> | 2020-03-06 17:22:39 +0000 |
| commit | e5d6142be00bbc2b68fb84756012690b312da965 (patch) | |
| tree | 7fee7681dcb34af703bbe2b0654911f39d401d63 /docs/index.rst | |
| parent | Update documentation to use markdown where possible (diff) | |
| download | pygensvm-e5d6142be00bbc2b68fb84756012690b312da965.tar.gz pygensvm-e5d6142be00bbc2b68fb84756012690b312da965.zip | |
Documentation improvements
This is an attempt to get the documentation work
correctly on RTD
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 34 |
1 files changed, 12 insertions, 22 deletions
diff --git a/docs/index.rst b/docs/index.rst index 6845d73..1a8e140 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,29 +3,19 @@ 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.txt +.. include:: ./readme.rst -GenSVMGridSearchCV -^^^^^^^^^^^^^^^^^^ - -.. include:: ./cls_gridsearch.txt - -Functions ---------- - -.. include:: ./auto_functions.txt +.. toctree:: + :caption: API Documentation + :maxdepth: 2 -.. include:: ./kernels.txt + cls_gensvm + cls_gridsearch + auto_functions + kernels -.. include:: ./CHANGELOG.rst +.. toctree:: + :caption: Further Documentation + :maxdepth: 2 + changelog |