update link to upper-constraints.txt

[multicloud/framework.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index bab9649..2248321 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,40 +1,58 @@
-# -*- coding: utf-8 -*-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
+roject = "onap"
+release = "master"
+version = "master"
+
+author = "Open Network Automation Platform"
+# yamllint disable-line rule:line-length
+copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
+
+pygments_style = "sphinx"
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+  "style_nav_header_background": "white",
+  "sticky_navigation": "False" }
+html_logo = "_static/logo_onap_2017.png"
+html_favicon = "_static/favicon.ico"
+html_static_path = ["_static"]
+html_show_sphinx = False
+
+extensions = [
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.graphviz',
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinxcontrib.swaggerdoc',
+    'sphinxcontrib.plantuml'
+]
+
 #
-#    http://www.apache.org/licenses/LICENSE-2.0
+# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
+# Change to {releasename} after you have created the new 'doc' branch.
 #
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-# implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
-import os
-import sys
+branch = 'latest'
 
-BASE_DIR = os.path.dirname(os.path.abspath(__file__))
-ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
+intersphinx_mapping = {}
+doc_url = 'https://docs.onap.org/projects'
+master_doc = 'index'
 
-sys.path.insert(0, ROOT)
-sys.path.insert(0, BASE_DIR)
+exclude_patterns = ['.tox']
 
-# -- General configuration ----------------------------------------------------
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_lang = "en_GB"
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    #'sphinx.ext.intersphinx'
-]
+#
+# Example:
+# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
+#
 
-# The suffix of source filenames.
-source_suffix = '.rst'
+html_last_updated_fmt = '%d-%b-%y %H:%M'
 
-# The master toctree document.
-master_doc = 'index'
+def setup(app):
+    app.add_css_file("css/ribbon.css")
 
-# General information about the project.
-project = u'MultiCloud Framework'
+linkcheck_ignore = [
+  r'http:\.*',
+  r'https:\.*'
+  r'\.*'
+]