From 17177d481a178c0ecea55f35f8ef785d47195ca8 Mon Sep 17 00:00:00 2001 From: Michal Jagiello Date: Wed, 12 Apr 2023 07:41:02 +0000 Subject: Fix errors related with doc-rules check Add missing config files Add missing CSS file Issue-ID: INT-2219 Signed-off-by: Michal Jagiello Change-Id: Id8316bd42a90e01015213f91c525c0d520ba3f4b --- docs/_static/css/custom.css | 3 --- docs/_static/css/ribbon.css | 63 +++++++++++++++++++++++++++++++++++++++++++++ docs/conf.py | 4 +-- docs/requirements-docs.txt | 7 +++++ docs/tox.ini | 31 ++++++++++++++++++++++ 5 files changed, 103 insertions(+), 5 deletions(-) delete mode 100644 docs/_static/css/custom.css create mode 100644 docs/_static/css/ribbon.css create mode 100644 docs/requirements-docs.txt create mode 100644 docs/tox.ini diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css deleted file mode 100644 index b07bdb1..0000000 --- a/docs/_static/css/custom.css +++ /dev/null @@ -1,3 +0,0 @@ -.wy-nav-content { - max-width: none; -} diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css new file mode 100644 index 0000000..7949130 --- /dev/null +++ b/docs/_static/css/ribbon.css @@ -0,0 +1,63 @@ +.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; + } +} + +/* fix width of the screen */ + +.wy-nav-content { + max-width: 800px; +} diff --git a/docs/conf.py b/docs/conf.py index b6dd084..536f6f9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,8 +19,8 @@ sys.path.insert(0, os.path.abspath('../src/onapsdk')) # -- Project information ----------------------------------------------------- project = 'ONAP SDK' -copyright = '2019, Sylvain Desbureaux' -author = 'Sylvain Desbureaux' +copyright = '2019, Orange. 2019, DT' +author = 'ONAP Integration team' # The full version, including alpha/beta/rc tags package_version = {} diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..71df2ab --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,7 @@ +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 new file mode 100644 index 0000000..b9d7eb4 --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,31 @@ +[tox] +minversion = 1.6 +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?h=master +commands = + 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?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