X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=7126e34886cdae91a1ca616c613be4608a4d0d58;hb=3665e0909f08e90c4d7a3b990a49bd0035e7c8b1;hp=580cce8a8426b60302cf6897f294e10097d071fa;hpb=22ef08574b5562794ae59c61ecebf8d596a9b5d3;p=doc.git diff --git a/docs/conf.py b/docs/conf.py index 580cce8a8..7126e3488 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,21 @@ extensions = [ 'sphinx.ext.doctest', 'sphinx.ext.graphviz', 'sphinx.ext.todo', - 'sphinx.ext.pngmath', + 'sphinx.ext.imgmath', 'sphinx.ext.viewcode', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.nwdiag', + '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' +nwdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -53,18 +65,19 @@ 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 = 'master branch' # The full version, including alpha/beta/rc tags. -release = 'test' +release = 'master branch' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -81,7 +94,9 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = [ + '_build' + ] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -115,6 +130,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 @@ -123,7 +139,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". @@ -153,7 +169,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. @@ -179,7 +195,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 @@ -359,3 +375,31 @@ 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', + r'http://yourhostname', + r'http://{PDP_URL}:\d+/', + r'http://.*simpledemo.onap.org:\d+/', + r'http://load-balanced-address:\d+/', + r'http://127.0.0.1', + r'http://ESR_SERVER_IP:\d+/', + r'http://MSB_SERVER_IP:\d+/', + r'http://msb_docker_host_ip:\d+/', + r'http://msb.onap.org/', + r'http://\$msb_address/', + r'http://hostIP:\d+/', + r'https://\$CBAM_IP:\d+/', + r'http://app-host:port/', + r'http://servername.domain.com', + r'https://we-are-message-router.us:\d+/', + r'https://we-are-data-router.us:\d+/', + r'http://prov.datarouternew.com:8443/', + r'http://www.[host]:[port]/', + r'http:/$', + r'https:/$', + r'http://$', + r'https://$', + r'http://app-host:port/' + ]