X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=245a0fbdb85e15cc19e0108b9364280463b4af08;hb=a6442ded924a335c3206beed00f633b0e81351b4;hp=0502b691c9f4eec6ff469abb0bad2bf8c6146c4f;hpb=4fcbb445017ad4384109aaf03f6572409e13af7c;p=docs.git diff --git a/docs/conf.py b/docs/conf.py old mode 100644 new mode 100755 index 0502b691c..245a0fbdb --- a/docs/conf.py +++ b/docs/conf.py @@ -13,14 +13,15 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys import os +import sys +import time 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 +31,7 @@ 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','sphinx.ext.graphviz'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -48,17 +49,14 @@ master_doc = 'index' # General information about the project. project = 'OpenDaylight Documentation' -copyright = '2016, OpenDaylight Project' +copyright = '2016-{}, OpenDaylight Project'.format(time.strftime("%Y")) author = 'OpenDaylight Project' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. -# -# The short X.Y version. -version = 'Boron' -# The full version, including alpha/beta/rc tags. -release = 'Boron' +version = 'Oxygen' # The short X.Y version. +release = version # The full version, including alpha/beta/rc tags. # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -118,6 +116,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. @@ -138,7 +138,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, @@ -160,7 +160,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. @@ -208,89 +210,7 @@ html_static_path = ['_static'] #html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'OpenDaylightDocumentationdoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'OpenDaylightDocumentation.tex', 'OpenDaylight Documentation Documentation', - 'OpenDaylight Project', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'opendaylightdocumentation', 'OpenDaylight Documentation Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'OpenDaylightDocumentation', 'OpenDaylight Documentation Documentation', - author, 'OpenDaylightDocumentation', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - +htmlhelp_basename = 'OpenDaylightDocumentation' linkcheck_ignore = [ # Ignore jenkins because it's often slow to respond. @@ -301,8 +221,14 @@ linkcheck_ignore = [ 'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder', ] -# Build integration stuff -import subprocess +nitpicky = True + +import platform +if platform.system() != 'Windows': + + # Build integration stuff + import subprocess + + subprocess.call(["./generate-milestone-status.sh"]) + subprocess.call(["./build-integration-robot-libdoc.sh"]) -subprocess.call(["./build-integration-robot-libdoc.sh"]) -subprocess.call(["./generate-javaapidoc.sh"])