docs/conf.py

   1 project = "onap"
   2 release = "master"
   3 version = "master"
   4
   5 doc_url = 'https://docs.onap.org/projects'
   6
   7 author = "Open Network Automation Platform"
   8 # yamllint disable-line rule:line-length
   9 copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
  10
  11 pygments_style = "sphinx"
  12 html_theme = "sphinx_rtd_theme"
  13 html_theme_options = {
  14   "style_nav_header_background": "white",
  15   "sticky_navigation": "False" }
  16 html_logo = "_static/logo_onap_2017.png"
  17 html_favicon = "_static/favicon.ico"
  18 html_static_path = ["_static"]
  19 html_show_sphinx = False
  20
  21 extensions = [
  22     'sphinx.ext.intersphinx',
  23     'sphinx.ext.graphviz',
  24     'sphinxcontrib.blockdiag',
  25     'sphinxcontrib.seqdiag',
  26     'sphinxcontrib.swaggerdoc',
  27     'sphinxcontrib.plantuml'
  28 ]
  29
  30 #
  31 # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
  32 # Change to {releasename} after you have created the new 'doc' branch.
  33 #
  34
  35 branch = 'latest'
  36
  37 intersphinx_mapping = {}
  38 intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None)
  39 doc_url = 'https://docs.onap.org/projects'
  40 master_doc = 'index'
  41
  42 exclude_patterns = ['.tox']
  43
  44 spelling_word_list_filename='spelling_wordlist.txt'
  45 spelling_lang = "en_GB"
  46
  47 #
  48 # Example:
  49 # intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
  50 #
  51
  52 html_last_updated_fmt = '%d-%b-%y %H:%M'
  53
  54 def setup(app):
  55     app.add_css_file("css/ribbon.css")
  56
  57 linkcheck_ignore = [
  58   r'http://localhost:\d+/'
  59 ]