From 04e189f5415fe0638792a8068a2cdca987fe4848 Mon Sep 17 00:00:00 2001 From: marcsello Date: Thu, 14 May 2020 18:11:56 +0200 Subject: [PATCH] Fixed sphinx config --- docs/conf.py | 17 +++++++++++------ docs/source/communicators.rst | 7 +++++++ docs/source/ip_watchdog.rst | 7 +++++++ docs/source/modules.rst | 3 +++ docs/source/redis_super_storage.rst | 7 +++++++ 5 files changed, 35 insertions(+), 6 deletions(-) create mode 100644 docs/source/communicators.rst create mode 100644 docs/source/ip_watchdog.rst create mode 100644 docs/source/redis_super_storage.rst diff --git a/docs/conf.py b/docs/conf.py index 1e0445d..57e0d2a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,9 +10,11 @@ # 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('..')) + +#import app # -- Project information ----------------------------------------------------- @@ -30,8 +32,7 @@ release = '0.1.0' # 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'] # Add any paths that contain templates here, relative to this directory. templates_path = [] @@ -52,4 +53,8 @@ html_theme = 'sphinx_rtd_theme' # 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 = [] \ No newline at end of file +html_static_path = [] + +# master document +master_doc = 'index' +autoclass_content = 'both' \ No newline at end of file diff --git a/docs/source/communicators.rst b/docs/source/communicators.rst new file mode 100644 index 0000000..38cd902 --- /dev/null +++ b/docs/source/communicators.rst @@ -0,0 +1,7 @@ +communicators module +==================== + +.. automodule:: communicators + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/ip_watchdog.rst b/docs/source/ip_watchdog.rst new file mode 100644 index 0000000..6daecdf --- /dev/null +++ b/docs/source/ip_watchdog.rst @@ -0,0 +1,7 @@ +ip\_watchdog module +=================== + +.. automodule:: ip_watchdog + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 7abee4e..09f1c7d 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -5,3 +5,6 @@ consumer-scheduler :maxdepth: 4 app + communicators + ip_watchdog + redis_super_storage \ No newline at end of file diff --git a/docs/source/redis_super_storage.rst b/docs/source/redis_super_storage.rst new file mode 100644 index 0000000..2ef2418 --- /dev/null +++ b/docs/source/redis_super_storage.rst @@ -0,0 +1,7 @@ +redis\_super\_storage module +============================ + +.. automodule:: redis_super_storage + :members: + :undoc-members: + :show-inheritance: