X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=2f240cce467f93fd6d23d3f4735fa22c1926ebda;hb=a4cf36ee390e3a221a3ee4e488b502771bb80894;hp=3d6211b2368be003233fa2b6b66dbf067f6fbe13;hpb=eb86c8664f056bb30b025692400ea6a72efe547c;p=docs.git diff --git a/docs/conf.py b/docs/conf.py index 3d6211b23..2f240cce4 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,17 +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','sphinx.ext.graphviz'] # 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 +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'] @@ -66,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. @@ -128,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. @@ -148,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, @@ -170,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. @@ -321,7 +325,6 @@ if platform.system() != 'Windows': # Disable javasphinx generation until we have a solution to long build # times. readthedocs timesout after 902 seconds. - subprocess.call(["rm","-rf","javadoc"]) - # if javasphinx_available: - # subprocess.call(["./generate-javaapidoc.sh"]) + if javasphinx_available: + subprocess.call(["./generate-javaapidoc.sh"])