X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=245a0fbdb85e15cc19e0108b9364280463b4af08;hb=6547fff1ae63b1a80af51d8fadd5075d151bb024;hp=5aa7bad1036732c3e6d351c48b25e8d85038a0aa;hpb=3335cc1bc25bc7b1d8fd28d6960b67b5cea4151a;p=docs.git diff --git a/docs/conf.py b/docs/conf.py index 5aa7bad10..245a0fbdb 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,8 +13,9 @@ # 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, @@ -32,16 +33,6 @@ sys.path.insert(0, os.path.abspath('submodules/spectrometer/server')) # ones. 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'] @@ -58,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 = 'Oxygen' -# The full version, including alpha/beta/rc tags. -release = 'Oxygen' +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. @@ -222,89 +210,7 @@ html_sidebars = { #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. @@ -323,10 +229,6 @@ if platform.system() != 'Windows': # Build integration stuff import subprocess + subprocess.call(["./generate-milestone-status.sh"]) 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"]) -