X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=0dfb669b4c0ce3102fe48043a6ede09e293474cb;hb=d4abee130b8b74b513fb175ee2b35192d6b53026;hp=28c80d6e4bb500ffb52703461ad4bbe6532ca779;hpb=199205046fd007c6888f34ec6968a0f8ba744535;p=docs.git diff --git a/docs/conf.py b/docs/conf.py index 28c80d6e4..0dfb669b4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,6 +15,7 @@ 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 @@ -31,6 +32,16 @@ import os # ones. extensions = [] +# 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 = '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. @@ -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. # " v documentation" by default. @@ -128,7 +143,7 @@ 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 @@ -301,3 +316,8 @@ 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. +subprocess.call(["rm","-rf","javadoc"]) +# if javasphinx_available: +# subprocess.call(["./generate-javaapidoc.sh"])