Merge "Get spectrometer autodoc working"

[docs.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 28c80d6e4bb500ffb52703461ad4bbe6532ca779..ebcd971aa055811e00ee0e7e5fac32057cb7fc49 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,11 +15,12 @@
 
 import sys
 import os
+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 ------------------------------------------------
 
@@ -29,7 +30,17 @@ import os
 # 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']
@@ -55,9 +66,9 @@ author = 'OpenDaylight Project'
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.0'
+version = 'Carbon'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.0'
+release = 'Carbon'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -109,15 +120,19 @@ todo_include_todos = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = 'bootstrap'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #html_theme_options = {}
+html_theme_options = {
+    'bootswatch_theme': "united",
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
@@ -128,12 +143,12 @@ html_theme = 'alabaster'
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = '_static/odl.png'
+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,
@@ -296,8 +311,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"])
 
-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"])