From 9a4e87fd2372b874ff437f536b9a7dcedbb05b13 Mon Sep 17 00:00:00 2001 From: Erik Reid <erik.reid@geant.org> Date: Sun, 24 Jan 2021 11:34:47 +0100 Subject: [PATCH] added some sphinx config --- docs/source/conf.py | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index cc152548..5c588cf6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -14,6 +14,14 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) +import os +import sys +sys.path.insert(0, os.path.abspath( + os.path.join( + os.path.dirname(__file__), + '..', '..', 'inventory_provider'))) + + # -- Project information ----------------------------------------------------- @@ -31,6 +39,9 @@ release = '0.57' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx_rtd_theme', + 'sphinx.ext.autodoc', + 'sphinx.ext.coverage' ] # Add any paths that contain templates here, relative to this directory. @@ -52,4 +63,9 @@ html_theme = 'alabaster' # 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'] + +# Both the class’ and the __init__ method’s docstring +# are concatenated and inserted. +autoclass_content = "both" +autodoc_typehints = "none" -- GitLab