X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=ebcd971aa055811e00ee0e7e5fac32057cb7fc49;hb=9e1081842f867d08caefe94236cd39efa11510b8;hp=f611c0d8632a15267c06186694b3ca158ebab140;hpb=fd30da72bf99e69c29fd21bc3b4276c8b6f1647c;p=docs.git diff --git a/docs/conf.py b/docs/conf.py index f611c0d86..ebcd971aa 100644 --- 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 = ['javasphinx'] +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 = '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. @@ -138,7 +148,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, @@ -301,7 +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"]) + + # 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"])