Updated git submodules

[docs.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 55b95462eaf84f9009690b1b46e804219f00c0d0..2d78db99dcee90a55fa262fce06551616d32e5dd 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -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,17 @@ 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']
+
+# Disable javasphinx generation until we have a solution to long build
+# times. readthedocs timesout after 902 seconds.
+javasphinx_available = False
+try:
+    import javasphinx
+    javasphinx_available = True
+    extensions.append('javasphinx')
+except ImportError, e:
+    pass
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -56,9 +66,9 @@ author = 'OpenDaylight Project'
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.0'
+version = 'Boron'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.0'
+release = 'Boron'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -118,6 +128,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 +150,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 +172,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.
@@ -301,7 +315,16 @@ linkcheck_ignore = [
     'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
 ]
 
-# Build integration stuff
-import subprocess
+import platform
+if platform.system() != 'Windows':
+
+    # Build integration stuff
+    import subprocess
+
+    subprocess.call(["./build-integration-robot-libdoc.sh"])
+
+    # Disable javasphinx generation until we have a solution to long build
+    # times. readthedocs timesout after 902 seconds.
+    if javasphinx_available:
+        subprocess.call(["./generate-javaapidoc.sh"])
 
-subprocess.call(["./build-integration-robot-libdoc.sh"])