Update git submodules
[docs.git] / docs / conf.py
index 07eb0ce54085d0911c9f46345f72d241d7db4550..41474107bb9e1527f6664a577ee0e65805670209 100644 (file)
@@ -20,7 +20,7 @@ import sphinx_bootstrap_theme
 # If extensions (or modules to document with autodoc) are in another directory,
 # 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.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('submodules/spectrometer/server'))
 
 # -- General configuration ------------------------------------------------
 
@@ -30,7 +30,7 @@ import sphinx_bootstrap_theme
 # 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.graphviz']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -56,9 +56,9 @@ author = 'OpenDaylight Project'
 # built documents.
 #
 # The short X.Y version.
-version = 'Boron'
+version = 'Carbon'
 # The full version, including alpha/beta/rc tags.
-release = 'Boron'
+release = 'Carbon'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -118,6 +118,8 @@ html_theme = 'bootstrap'
 #html_theme_options = {}
 html_theme_options = {
     'bootswatch_theme': "united",
+    'navbar_sidebarrel': False,
+    'source_link_position': "footer",
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -138,7 +140,7 @@ html_logo = '_static/odl_small.png'
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+html_favicon = 'favicon.ico'
 
 # 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,
@@ -160,7 +162,9 @@ html_static_path = ['_static']
 #html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+html_sidebars = {
+    '**': ['localtoc.html', 'relations.html'],
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
@@ -207,6 +211,10 @@ html_static_path = ['_static']
 # implements a search results scorer. If empty, the default will be used.
 #html_search_scorer = 'scorer.js'
 
+html_context = {
+    'version_status': 'unsupported',
+}
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'OpenDaylightDocumentationdoc'
 
@@ -301,7 +309,12 @@ linkcheck_ignore = [
     'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
 ]
 
-# Build integration stuff
-import subprocess
+nitpicky = True
+
+import platform
+if platform.system() != 'Windows':
+
+    # Build integration stuff
+    import subprocess
 
-subprocess.call(["./build-integration-robot-libdoc.sh"])
+    subprocess.call(["./build-integration-robot-libdoc.sh"])