Finalise documentation as per doc procedure p02

Issue-ID: CPS-1321
Signed-off-by: seanbeirne <sean.beirne@est.tech>
Change-Id: If502aa0a8adca8cae6b856fb2d8f37e2eb16b590

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 caaf753..c3161ec 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,5 +1,5 @@
 #  ============LICENSE_START=======================================================
-#  Copyright (C) 2021 Nordix Foundation
+#  Copyright (C) 2022 Nordix Foundation
 #  ================================================================================
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -18,13 +18,42 @@
 
 
 from docutils.parsers.rst import directives
-from docs_conf.conf import *
 
-#change 'latest' to relevant branch-name once branch has been created
+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
+
+extensions = [
+    'sphinx.ext.intersphinx','sphinxcontrib.blockdiag',
+    'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz']
+
+#
+# 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'
 
+exclude_patterns = ['.tox']
+
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_lang = "en_GB"
+
 intersphinx_mapping = {}
 
 intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None)
@@ -32,6 +61,8 @@ intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/
 
 linkcheck_ignore = [
     'http://localhost',
+    'https://example.com',
+    'about:config'
 ]
 
 html_last_updated_fmt = '%d-%b-%y %H:%M'

diff --git a/docs/content/deployment.rst b/docs/content/deployment.rst
index 962f8b6..d67a70a 100644 (file)
--- a/docs/content/deployment.rst
+++ b/docs/content/deployment.rst
@@ -261,5 +261,5 @@ production upgrade).
 
 For more details about TimescaleDB and PostgresSQL upgrades, refer to:
 
-* `Updating TimescaleDB versions <https://docs.timescale.com/timescaledb/latest/how-to-guides/update-timescaledb/>`_
+* `Updating TimescaleDB versions <https://docs.timescale.com/timescaledb/latest/how-to-guides/>`_
 * `Upgrading a PostgreSQL Cluster <https://www.postgresql.org/docs/14/upgrading.html>`_

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

diff --git a/docs/spelling_words.txt b/docs/spelling_words.txt
new file mode 100644 (file)
index 0000000..4417cc8
--- /dev/null
+++ b/docs/spelling_words.txt
@@ -0,0 +1,10 @@
+Goodger
+Mär
+docinfo
+overlined
+Docutils
+csv
+sectnum
+reST
+unicode
+defs
\ No newline at end of file

diff --git a/docs/tox.ini b/docs/tox.ini
index 9313c9e..dc46706 100644 (file)
--- a/docs/tox.ini
+++ b/docs/tox.ini
@@ -18,27 +18,29 @@
 
 [tox]
 minversion = 1.6
-envlist = docs
+envlist = docs,docs-linkcheck,docs-spellcheck
 skipsdist = true
-
 [testenv:docs]
 basepython = python3.8
-deps = -r{toxinidir}/requirements-docs.txt
-       -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-       -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
 commands =
-    sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
-    echo "Generated docs available in {toxinidir}/_build/html"
-whitelist_externals =
-    echo
-    git
-    sh
-
+    sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
 [testenv:docs-linkcheck]
 basepython = python3.8
-deps = -r{toxinidir}/requirements-docs.txt
-       -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
-       -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
-commands = echo "Link Checking not enforced"
-whitelist_externals =
-    echo
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+    sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
+[testenv:docs-spellcheck]
+basepython = python3.8
+deps =
+    -r{toxinidir}/requirements-docs.txt
+    -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+    -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+    sphinx-build -W -q -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck