X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=51f34d46a871cbf983d89dc2c12275ed3954683f;hb=5b7a1cd674e00868a549ec5a343a3ff3104dd7fa;hp=2c112bd308bede5da20defeaccf8c86b43d0302b;hpb=31af8cccb0ccc0c2675f6d48b8312ce2a14aadf9;p=docs.git diff --git a/docs/conf.py b/docs/conf.py old mode 100644 new mode 100755 index 2c112bd30..51f34d46a --- 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','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 # 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 = 'Nitrogen' # The full version, including alpha/beta/rc tags. -release = '0.3.0' +release = 'Nitrogen' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -109,15 +120,21 @@ 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", + 'navbar_sidebarrel': False, + 'source_link_position': "footer", +} # 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,12 +145,12 @@ html_theme = 'alabaster' # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +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, @@ -155,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. @@ -285,3 +304,29 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + + +linkcheck_ignore = [ + # Ignore jenkins because it's often slow to respond. + 'https://jenkins.opendaylight.org/releng', + 'https://jenkins.opendaylight.org/sandbox', + 'http://\$CONTROL_HOST:8181/dlux/index.html', + # The '#' in the path makes sphinx think it's an anchor + 'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder', +] + +nitpicky = True + +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"]) +