diff options
author | marineMD <marine.de.dorlodot@intl.att.com> | 2022-11-16 15:18:28 +0100 |
---|---|---|
committer | thmsdt <thomas.kulik@telekom.de> | 2022-11-17 09:07:01 +0100 |
commit | f1e199534a73fd603359362eeca822bd1d66f725 (patch) | |
tree | 73faffe934b346c85b9682b2efc0ed583dc9d031 | |
parent | 170295f14e4c5eaeca2967046fdb7219362233ba (diff) |
Fix DOC config files
Issue-ID: DOC-798
Signed-off-by: marineMD <marine.de.dorlodot@intl.att.com>
Change-Id: I3392be17a6628ca6e24188f3cae728a4a9c641bb
(cherry picked from commit b17695db30a02c71373d5c416a08594841f87a96)
-rw-r--r-- | .gitreview | 1 | ||||
-rw-r--r-- | docs/_static/css/ribbon.css | 125 | ||||
-rw-r--r-- | docs/conf.py | 51 | ||||
-rw-r--r-- | docs/conf.yaml | 7 | ||||
-rw-r--r-- | docs/process.rst | 2 | ||||
-rw-r--r-- | docs/requirements-docs.txt | 6 | ||||
-rw-r--r-- | docs/tox.ini | 39 | ||||
-rw-r--r-- | osa/OSA-2019-009.rst | 2 |
8 files changed, 141 insertions, 92 deletions
@@ -2,3 +2,4 @@ host=gerrit.onap.org port=29418 project=osa.git +defaultbranch=kohn diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css index 6008cb1..0e624fc 100644 --- a/docs/_static/css/ribbon.css +++ b/docs/_static/css/ribbon.css @@ -1,63 +1,66 @@ .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; - -} - -.ribbon a { - border: 1px solid #faa; - color: #fff; - display: block; - font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; - margin: 1px 0; - padding: 10px 50px; - text-align: center; - text-decoration: none; - text-shadow: 0 0 5px #444; - transition: 0.5s; -} - -.ribbon a:hover { - background: #c11; - color: #fff; -} - - -/* override table width restrictions */ -@media screen and (min-width: 767px) { - - .wy-table-responsive table td, .wy-table-responsive table th { - /* !important prevents the common CSS stylesheets from overriding - this as on RTD they are loaded after this stylesheet */ - white-space: normal !important; - } - - .wy-table-responsive { - overflow: visible !important; - } -} - -@media screen and (max-width: 767px) { - .wy-table-responsive table td { - white-space: nowrap; + 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 { + border: 1px solid #faa; + color: #fff; + display: block; + font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; + margin: 1px 0; + padding: 10px 50px; + text-align: center; + text-decoration: none; + text-shadow: 0 0 5px #444; + transition: 0.5s; + } + + .ribbon a:hover { + background: #c11; + color: #fff; + } + + + /* override table width restrictions */ + @media screen and (min-width: 767px) { + + .wy-table-responsive table td, .wy-table-responsive table th { + /* !important prevents the common CSS stylesheets from overriding + this as on RTD they are loaded after this stylesheet */ + white-space: normal !important; } -} - -/* fix width of the screen */ - -.wy-nav-content { - max-width: none; -} + + .wy-table-responsive { + overflow: visible !important; + } + } + + @media screen and (max-width: 767px) { + .wy-table-responsive table td { + white-space: nowrap; + } + } + + /* fix width of the screen */ + + .wy-nav-content { + max-width: 800px; + } + + +
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index d211470..4b2fec5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,15 +1,56 @@ -from docs_conf.conf import * +project = "onap" +release = "kohn" +version = "kohn" -branch = 'latest' -master_doc = 'index' +author = "Open Network Automation Platform" +# yamllint disable-line rule:line-length +copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License" -linkcheck_ignore = [ - 'http://localhost', +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 = 'kohn' + intersphinx_mapping = {} +doc_url = 'https://docs.onap.org/projects' +master_doc = 'index' + +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 diff --git a/docs/conf.yaml b/docs/conf.yaml deleted file mode 100644 index ab59281..0000000 --- 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/process.rst b/docs/process.rst index ed6c471..ec75eb4 100644 --- a/docs/process.rst +++ b/docs/process.rst @@ -301,4 +301,4 @@ References ---------- * `Common Vulnerabilities and Exposure <https://cve.mitre.org/about/faqs.html>`_ * `CVE numbering authorities <https://cve.mitre.org/cve/cna.html>`_ -* `CVE FAQ <https://cve.mitre.org/about/faqs.html#what_is_cve_identifier>`_ +* `CVE FAQ <https://www.cve.org/ResourcesSupport/FAQs#pc_introwhat_is_cve>`_ diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 3b3441a..ba3e0ec 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
\ No newline at end of file diff --git a/docs/tox.ini b/docs/tox.ini index 42ffa68..d1bc610 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -1,25 +1,32 @@ [tox] minversion = 1.6 -envlist = docs, +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] -basepython = python3 +basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn 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 -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html -[testenv:docs-linkcheck] -basepython = python3 -#deps = -r{toxinidir}/requirements-docs.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo +#[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?h=kohn +#commands = +# sphinx-build -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=kohn +commands = + sphinx-build -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck +
\ No newline at end of file diff --git a/osa/OSA-2019-009.rst b/osa/OSA-2019-009.rst index 80eb1fc..feee019 100644 --- a/osa/OSA-2019-009.rst +++ b/osa/OSA-2019-009.rst @@ -26,7 +26,7 @@ Radosław Żeszczuk from Samsung reported vulnerability in HOLMES. By accessing Patches ------- -* `87090 <https://gerrit.onap.org/r/#/c/holmes/engine-management/+/87090/>`_ +* `87090 <https://gerrit.onap.org/r/c/holmes/engine-management/+/87090/>`_ Credits ------- |