From e5d6142be00bbc2b68fb84756012690b312da965 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 6 Mar 2020 17:22:39 +0000 Subject: Documentation improvements This is an attempt to get the documentation work correctly on RTD --- docs/index.rst | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) (limited to 'docs/index.rst') 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 -- cgit v1.2.3 From 03825363b5817181824df1e28238de2ae098943e Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 6 Mar 2020 17:28:57 +0000 Subject: Update sphinx config --- docs/index.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 1a8e140..55b6a10 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,11 @@ .. include:: ./readme.rst +.. toctree:: + :maxdepth: 2 + + readme + .. toctree:: :caption: API Documentation :maxdepth: 2 -- cgit v1.2.3