docs/conf.py

   1 project = "onap"
   2 release = "master"
   3 version = "master"
   4
   5 author = "Open Network Automation Platform"
   6 # yamllint disable-line rule:line-length
   7 copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
   8
   9 pygments_style = "sphinx"
  10 html_theme = "sphinx_rtd_theme"
  11 html_theme_options = {
  12     "style_nav_header_background": "white",
  13     "sticky_navigation": "False" }
  14 html_logo = "_static/logo_onap_2017.png"
  15 html_favicon = "_static/favicon.ico"
  16 html_static_path = ["_static"]
  17 html_show_sphinx = False
  18
  19 extensions = [
  20     'sphinx.ext.intersphinx',
  21     'sphinx.ext.graphviz',
  22     'sphinxcontrib.blockdiag',
  23     'sphinxcontrib.seqdiag',
  24     'sphinxcontrib.swaggerdoc',
  25     'sphinxcontrib.plantuml'
  26 ]
  27
  28 #
  29 # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
  30 # Change to {releasename} after you have created the new 'doc' branch.
  31 #
  32
  33 branch = 'latest'
  34
  35 intersphinx_mapping = {}
  36 doc_url = 'https://docs.onap.org/projects'
  37 master_doc = 'index'
  38
  39 exclude_patterns = ['.tox']
  40
  41 spelling_lang = "en_GB"
  42 spelling_word_list_filename='spelling_wordlist.txt'
  43 spelling_exclude_patterns=['release-notes.rst']
  44
  45 linkcheck_ignore = [
  46     'http://localhost',
  47     'https://example.com',
  48     'about:config',
  49     # this URL is not directly reachable and must be configured in the system hosts file.
  50     'https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm',
  51     # anchor issues
  52     'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#.*',
  53     'https://docs.linuxfoundation.org/docs/communitybridge/easycla/contributors/contribute-to-a-gerrit-project#.*',
  54     'https://docs.onap.org/projects/onap-integration/en/latest/docs_robot.html#docs-robot',
  55     'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases_release.html#docs-usecases-release',
  56     'https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases',
  57     'https://docs.onap.org/projects/onap-integration/en/latest/usecases/release_non_functional_requirements.html#release-non-functional-requirements',
  58 ]
  59
  60
  61 html_last_updated_fmt = '%d-%b-%y %H:%M'
  62
  63
  64 def setup(app):
  65     app.add_css_file("css/ribbon.css")