X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=91d4ee011335db4c84ea57a5ed8b17b4899594ee;hb=bdde3752a82a808394141018a39e2450a4dd58f9;hp=b3d7533234d2059542d53c6df43595d3e0eaf065;hpb=d1f094919f1558d05f5aa72e209ad9359135bcf4;p=doc.git diff --git a/docs/conf.py b/docs/conf.py index b3d753323..91d4ee011 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,6 +15,7 @@ import sys import os import shlex +#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 @@ -24,7 +25,7 @@ import shlex # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +needs_sphinx = '1.5.3' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -34,10 +35,19 @@ extensions = [ 'sphinx.ext.doctest', 'sphinx.ext.graphviz', 'sphinx.ext.todo', - 'sphinx.ext.pngmath', + 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.seqdiag', + 'sphinx.ext.ifconfig', + 'sphinx.ext.todo', + 'sphinxcontrib.plantuml', + 'sphinxcontrib.swaggerdoc' ] +# Font path for seqdiag +seqdiag_fontpath= '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -53,18 +63,20 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'ONAP' -copyright = u'2017, ONAP Contributors' -author = u'ONAP Contributors' +project = u'' +copyright = u'2017 ONAP. Licensed under Creative Commons Attribution 4.0 International License' + + +author = u'Open Network Automation Platform' # 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 = 'test' +version = '1.0.0' # The full version, including alpha/beta/rc tags. -release = 'test' +release = 'Amsterdam' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -82,8 +94,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [ - '_build', - 'templates' + '_build' ] # The reST default role (used for this markup: `text`) to use for all @@ -118,6 +129,7 @@ todo_include_todos = True # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. +#html_theme = 'bootstrap' html_theme = 'classic' # Theme options are theme-specific and customize the look and feel of a theme @@ -126,7 +138,7 @@ html_theme = 'classic' #html_theme_options = {} # 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. If None, it defaults to # " v documentation". @@ -156,7 +168,7 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = '%d-%b-%y %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -182,7 +194,7 @@ html_static_path = ['_static'] #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +html_show_sphinx = False # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True @@ -362,3 +374,7 @@ epub_exclude_files = ['search.html'] # If false, no index is generated. #epub_use_index = True + +# Patterns to ignore in linkcheck builder +linkcheck_ignore = [r'http://localhost:\d+/'] +