diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_static/css/ribbon.css | 123 | ||||
| -rw-r--r-- | docs/conf.py | 64 | ||||
| -rw-r--r-- | docs/conf.yaml | 7 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 8 | ||||
| -rw-r--r-- | docs/sections/offeredapis.rst | 25 | ||||
| -rw-r--r-- | docs/sections/release-notes.rst | 10 | ||||
| -rw-r--r-- | docs/tox.ini | 27 |
7 files changed, 152 insertions, 112 deletions
diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css index 6008cb1..db927a4 100644 --- a/docs/_static/css/ribbon.css +++ b/docs/_static/css/ribbon.css @@ -1,63 +1,64 @@ .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 9b84263..172975d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,14 +1,59 @@ -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', + 'sphinxcontrib.redoc' +] + +# +# 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' + +intersphinx_mapping = {} +doc_url = 'https://docs.onap.org/projects' master_doc = 'index' -linkcheck_ignore = [ - 'http://localhost', -] +exclude_patterns = ['.tox'] -extensions = [ - 'sphinxcontrib.redoc', +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+/' ] redoc = [ @@ -27,10 +72,3 @@ redoc = [ ] redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' - -intersphinx_mapping = {} - -html_last_updated_fmt = '%d-%b-%y %H:%M' - -def setup(app): - app.add_css_file("css/ribbon.css") 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/requirements-docs.txt b/docs/requirements-docs.txt index 96c8de2..79f484e 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,2 +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 sphinxcontrib-redoc diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst index e7d9f1f..c9af97d 100644 --- a/docs/sections/offeredapis.rst +++ b/docs/sections/offeredapis.rst @@ -3,7 +3,7 @@ .. _offeredapis: Offered APIs -============================================= +============ This document describes the OSDF HAS (Homing and Allocation Service) API @@ -17,15 +17,14 @@ paste into the swagger tool here: https://editor.swagger.io "OOF OSDF HAS API", ":download:`link <../api/swagger/oof-osdf-has-api.json>`" "OOF OPTENG API", ":download:`link <../api/swagger/oof-optf-opteng-api.json>`" - -OOF OSDF HAS API -................ - -`OSDF API <osdf-api.html>`_ - - -OOF OPTENG API -.............. - -`OPTENG API <opteng-api.html>`_ - + +.. OOF OSDF HAS API +.. ................ +.. +.. `OSDF API <osdf-api.html>`_ +.. +.. +.. OOF OPTENG API +.. .............. +.. +.. `OPTENG API <opteng-api.html>`_ diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index 62b6fe6..63ab538 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -646,12 +646,12 @@ The Dublin release for OOF delivered the following Epics. *Known Vulnerabilities in Used Modules* OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. -The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_. +The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`__. Quick Links: - - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_ - - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`_ - - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`_ + - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`__ + - `Passing Badge information for OPTFRA <https://bestpractices.coreinfrastructure.org/en/projects/1720>`__ + - `Project Vulnerability Review Table for OPTF <https://wiki.onap.org/pages/viewpage.action?pageId=64005463>`__ **Upgrade Notes** @@ -739,7 +739,7 @@ The Casablanca release for OOF delivered the following Epics. **Security Notes** OPTFRA osdf code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. -The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`_. +The OPTF open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=43385924>`__. Quick Links: - `OPTFRA project page <https://wiki.onap.org/display/DW/Optimization+Framework+Project>`_ diff --git a/docs/tox.ini b/docs/tox.ini index 980bc22..9d0f3ee 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,21 +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 -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" -#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 -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 -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |