summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorshashikanth.vh@huawei.com <shashikanth.vh@huawei.com>2022-11-02 09:26:41 +0530
committershashikanth.vh@huawei.com <shashikanth.vh@huawei.com>2022-11-07 04:16:20 +0530
commitf384d73879f953e12bb8c4f90b9015299f3d0d66 (patch)
treeaea74943ff9db6dd3eba44c939742391a805f0c6
parent85996ada6d9a044d3849176cb1ffa017eb6d4406 (diff)
doc config files update
Issue-ID: SO-4017 Signed-off-by: Shashikanth.vh <shashikanth.vh@huawei.com> Change-Id: Iccffa68a8aac194ef23514ca8b1e9a6b7e3ef325
-rw-r--r--.readthedocs.yaml6
-rw-r--r--docs/_static/css/ribbon.css2
-rw-r--r--docs/conf.py38
-rw-r--r--docs/requirements-docs.txt5
4 files changed, 46 insertions, 5 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 3797dc8b..82889b5a 100644
--- 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 6008cb1a..afb9480d 100644
--- 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 d211470a..a6063226 100644
--- 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 3b3441a8..0cfb2ae2 100644
--- 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