---
# .readthedocs.yml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-# Required
+# # Read the Docs configuration file
+# # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# # Required
+#
version: 2
-formats:
- - htmlzip
-
build:
image: latest
python:
version: 3.7
install:
- - requirements: requirements.txt
+ - requirements: docs/requirements-docs.txt
+
+submodules:
+ include: all
sphinx:
- configuration: docs/conf.py
+ configuration: docs/conf.py
\ No newline at end of file
-from docs_conf.conf import *
+project = "onap"
+release = "kohn"
+version = "kohn"
-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"
-branch = 'latest'
-master_doc = 'index'
+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
-linkcheck_ignore = [
- 'http://localhost',
+extensions = [
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.graphviz',
+ 'sphinxcontrib.blockdiag',
+ 'sphinxcontrib.seqdiag',
+ 'sphinxcontrib.swaggerdoc',
+ 'sphinxcontrib.plantuml'
]
+#
+# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
+# Change to {releasename} after you have created the new 'doc' branch.
+#
+
+branch = 'kohn'
+
intersphinx_mapping = {}
+doc_url = 'https://docs.onap.org/projects'
+master_doc = 'index'
-html_last_updated_fmt = '%d-%b-%y %H:%M'
+exclude_patterns = ['.tox']
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_lang = "en_GB"
+
+#
+# Example:
+# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
+#
+
+html_last_updated_fmt = '%d-%b-%y %H:%M'
def setup(app):
app.add_css_file("css/ribbon.css")
+
+linkcheck_ignore = [
+ r'http://localhost:\d+/'
+]
\ No newline at end of file
====================================
Holmes provides alarm correlation and analysis for telecom cloud infrastructure
-and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root
+and services, including hosts, VIMs, VNFs and NSs. Holmes aims to find the root
reason which causes the failure or degradation of services by digging into the
ocean of events collected from different levels of the telecom cloud.