diff --git a/docs/source/conf.py b/docs/source/conf.py index f2acdbf..fa1baf9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,14 +10,14 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys +sys.path.insert(0, os.path.abspath('../..')) # -- Project information ----------------------------------------------------- -project = 'ValInvest' +project = 'Valinvest' copyright = '2020, Guillaume Rey' author = 'Guillaume Rey' @@ -30,8 +30,8 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ -] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon' + ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -52,4 +52,4 @@ # 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst index ce8346f..58b4563 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,17 +1,12 @@ -.. ValInvest documentation master file, created by - sphinx-quickstart on Fri Feb 7 20:00:18 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Welcome to ValInvest's documentation! ===================================== +.. automodule:: valinvest.fundamentals + :members: .. toctree:: :maxdepth: 2 :caption: Contents: - - Indices and tables ==================