From e1fcf7a6eb1dd8d76fe3ec9562451f031b6917ba Mon Sep 17 00:00:00 2001 From: marineMD Date: Mon, 14 Nov 2022 16:09:52 +0100 Subject: Fix DOC config files Issue-ID: DOC-798 Signed-off-by: marineMD Change-Id: I957caa5fb808d623c1d3c12255c0f587a81064a7 (cherry picked from commit 122d630f1703c51b73676ecf0c1622fd3f882d78) --- .gitreview | 1 + docs/_static/css/ribbon.css | 34 ++++++++++---------- docs/conf.py | 77 ++++++++++++++++++++++++++++++++++----------- docs/conf.yaml | 7 ----- docs/onap-oom-heat.rst | 10 +++--- docs/requirements-docs.txt | 6 +++- docs/tox.ini | 26 ++++++++------- 7 files changed, 101 insertions(+), 60 deletions(-) delete mode 100644 docs/conf.yaml diff --git a/.gitreview b/.gitreview index 6e77300ea..476096444 100644 --- a/.gitreview +++ b/.gitreview @@ -2,3 +2,4 @@ host=gerrit.onap.org port=29418 project=integration.git +defaultbranch=master diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css index 6008cb1a0..7949130b3 100644 --- a/docs/_static/css/ribbon.css +++ b/docs/_static/css/ribbon.css @@ -1,20 +1,20 @@ .ribbon { - z-index: 1000; - background-color: #a00; - overflow: hidden; - white-space: nowrap; - position: fixed; - top: 25px; - right: -50px; - -webkit-transform: rotate(45deg); - -moz-transform: rotate(45deg); - -ms-transform: rotate(45deg); - -o-transform: rotate(45deg); - transform: rotate(45deg); - -webkit-box-shadow: 0 0 10px #888; - -moz-box-shadow: 0 0 10px #888; - box-shadow: 0 0 10px #888; - + z-index: 1000; + background-color: #a00; + overflow: hidden; + white-space: nowrap; + position: fixed; + top: 25px; + right: -50px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -ms-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + -webkit-box-shadow: 0 0 10px #888; + -moz-box-shadow: 0 0 10px #888; + box-shadow: 0 0 10px #888; + } .ribbon a { @@ -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 b351570aa..14f37ca67 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,33 +1,72 @@ -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 + +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 = 'latest' -master_doc = 'index' +intersphinx_mapping = {} doc_url = 'https://docs.onap.org/projects' +master_doc = 'index' -linkcheck_ignore = [ - r'http://localhost:.*', - 'http://CONSUL_SERVER_UI:30270/ui/#/dc1/services', - r'https://.*h=frankfurt', - r'http.*frankfurt.*', - r'http.*simpledemo.onap.org.*', - r'http://ANY_K8S_IP.*', - 'http://so-monitoring:30224', - r'http://SINK_IP_ADDRESS:667.*', - r'http.*K8S_HOST:30227.*', - r'http.*K8S_NODE_IP.*', - r'http.*REPO_IP.*', - 'http://team.onap.eu', - 'https://tools.ietf.org/html/rfc8345' -] +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) +# intersphinx_mapping = {} intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) html_last_updated_fmt = '%d-%b-%y %H:%M' -exclude_patterns = ['.tox/**'] - def setup(app): app.add_css_file("css/ribbon.css") + +linkcheck_ignore = [ + r'http://localhost:\d+/' + r'http://localhost:.*', + r'http://CONSUL_SERVER_UI:30270/ui/#/dc1/services', + r'https://.*h=frankfurt', + r'http.*frankfurt.*', + r'http.*simpledemo.onap.org.*', + r'http://ANY_K8S_IP.*', + r'http://so-monitoring:30224', + r'http://SINK_IP_ADDRESS:667.*', + r'http.*K8S_HOST:30227.*', + r'http.*K8S_NODE_IP.*', + r'http.*REPO_IP.*', + r'http://team.onap.eu', + r'https://tools.ietf.org/html/rfc8345' +] diff --git a/docs/conf.yaml b/docs/conf.yaml deleted file mode 100644 index ab5928131..000000000 --- a/docs/conf.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -project_cfg: onap -project: onap - -# Change this to ReleaseBranchName to modify the header -default-version: latest -# diff --git a/docs/onap-oom-heat.rst b/docs/onap-oom-heat.rst index 54c226114..13e6ca6db 100644 --- a/docs/onap-oom-heat.rst +++ b/docs/onap-oom-heat.rst @@ -24,10 +24,10 @@ must be adapted according to your context. Source files ~~~~~~~~~~~~ -- HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-rke?h=guilin -- Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/Integration-SB-00-openrc?h=guilin -- Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env?h=guilin -- Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-rke/scripts/deploy.sh?h=guilin +- HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-rke +- Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/Integration-SB-00-openrc +- Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env +- Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-rke/scripts/deploy.sh Heat Template Description @@ -35,7 +35,7 @@ Heat Template Description The ONAP Integration Project provides a sample HEAT template that fully automates the deployment of ONAP using OOM as described in -OOM documentation, see :ref:`OOM ` for details. +OOM documentation. The ONAP OOM HEAT template deploys the entire ONAP platform. It spins up an HA-enabled Kubernetes cluster, and deploys ONAP using OOM onto diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 3b3441a80..71df2ab0d 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,3 +1,7 @@ -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 diff --git a/docs/tox.ini b/docs/tox.ini index 543b20671..b9d7eb44b 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = docs, +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] @@ -8,20 +8,24 @@ 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 + -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 = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo + -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 -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck -- cgit 1.2.3-korg