doc config files update

Issue-ID: SO-4017

Signed-off-by: Shashikanth.vh <shashikanth.vh@huawei.com>
Change-Id: Iccffa68a8aac194ef23514ca8b1e9a6b7e3ef325

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 3797dc8..82889b5 100644 (file)
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -5,9 +5,6 @@
 # Required
 version: 2
 
-formats:
-  - htmlzip
-
 build:
   image: latest
 
@@ -16,5 +13,8 @@ python:
   install:
     - requirements: docs/requirements-docs.txt
 
+submodules:
+   include: all
+
 sphinx:
   configuration: docs/conf.py

diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css
index 6008cb1..afb9480 100644 (file)
--- a/docs/_static/css/ribbon.css
+++ b/docs/_static/css/ribbon.css
@@ -59,5 +59,5 @@
 /* fix width of the screen */
 
 .wy-nav-content {
-    max-width: none;
+    max-width: 800px;
 }

diff --git a/docs/conf.py b/docs/conf.py
index d211470..a606322 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,10 +1,44 @@
 from docs_conf.conf import *
 
+project = "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
+
+#
+# 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 = 'latest'
+doc_url = 'https://docs.onap.org/projects'
+
 master_doc = 'index'
 
 linkcheck_ignore = [
-    'http://localhost',
+    r'http://localhost:\d+/'
+]
+
+extensions = [
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.graphviz',
+    'sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag',
+    'sphinxcontrib.swaggerdoc',
+    'sphinxcontrib.plantuml'
 ]
 
 intersphinx_mapping = {}
@@ -13,3 +47,5 @@ html_last_updated_fmt = '%d-%b-%y %H:%M'
 
 def setup(app):
     app.add_css_file("css/ribbon.css")
+
+

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 3b3441a..0cfb2ae 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,3 +1,8 @@
 lfdocs-conf
 sphinx>=4.2.0  # BSD
 sphinx-rtd-theme>=1.0.0  # MIT
+sphinxcontrib-blockdiag  # BSD
+sphinxcontrib-seqdiag # BSD
+sphinxcontrib-swaggerdoc
+sphinxcontrib-spelling
+sphinxcontrib-plantuml