diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 1 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/index.rst | 7 |
3 files changed, 5 insertions, 7 deletions
diff --git a/docs/Makefile b/docs/Makefile index ac6c1f0..3e676b0 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -17,4 +17,5 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile + python ./generate_autodocs.py @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py index c3e5af1..8a02df3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,7 +40,6 @@ class Mock(MagicMock): MOCK_MODULES = ['gensvm.wrapper'] sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) - # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -50,7 +49,8 @@ sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinx.ext.autodoc', +extensions = [ + 'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', diff --git a/docs/index.rst b/docs/index.rst index d8f8425..7f539b8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,17 +9,14 @@ Classes ======= -The complete documentation of the available GenSVM classes is presented below. - GenSVM ------ -.. autoclass:: gensvm.core.GenSVM +.. include:: ./cls_gensvm.rst GenSVMGridSearchCV ------------------ -.. autoclass:: gensvm.gridsearch.GenSVMGridSearchCV - +.. include:: ./cls_gridsearch.rst .. include:: ../CHANGELOG.rst |