Adopt new docs/tox API
- toc.ini changed
- spelling issue reported by Rao addressed
- trigger
Issue-ID: OAM-335
Change-Id: Ie887a8931c40331014c5db34bca5e1b2336ce9d2
Signed-off-by: Martin Skorupski <martin.skorupski@highstreet-technologies.com>
diff --git a/docs/faq.rst b/docs/faq.rst
index 3a4345d..98a281a 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -9,7 +9,7 @@
Frequently asked questions
==========================
-Which browser should I use to operate Opendaylight SDN-R User interface?
+Which browser should I use to operate OpenDaylight SDN-R User interface?
------------------------------------------------------------------------
An actual version of `Google
@@ -47,7 +47,7 @@
--------------
-Which commands should be used to analyse karaf logs?
+Which commands should be used to analyze karaf logs?
----------------------------------------------------
::
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index c6b1538..e3104a7 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -211,7 +211,7 @@
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| `OAM-184 <https://jira.o-ran-sc.org/browse/OAM-184>`__ | Create VES client example for domain 'stateChange' |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
-| `OAM-185 <https://jira.o-ran-sc.org/browse/OAM-185>`__ | Create VES client example for domain 'stndefined' |
+| `OAM-185 <https://jira.o-ran-sc.org/browse/OAM-185>`__ | Create VES client example for domain 'stndDefined' |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| `OAM-187 <https://jira.o-ran-sc.org/browse/OAM-187>`__ | Update Jenkins Jobs |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
@@ -271,7 +271,7 @@
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| `OAM-184 <https://jira.o-ran-sc.org/browse/OAM-184>`__ | Create VES client example for domain 'stateChange' |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
-| `OAM-185 <https://jira.o-ran-sc.org/browse/OAM-185>`__ | Create VES client example for domain 'stndefined' |
+| `OAM-185 <https://jira.o-ran-sc.org/browse/OAM-185>`__ | Create VES client example for domain 'stndDefined' |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
| `OAM-187 <https://jira.o-ran-sc.org/browse/OAM-187>`__ | Update Jenkins Jobs |
+--------------------------------------------------------------------+-------------------------------------------------------------------------+
@@ -354,12 +354,12 @@
-------------------------
* What is an SMO?
-* Provide xRAN datamodels
+* Provide xRAN data-models
* Provide curl bash scripts for Software Management
* Add jenkins jobs for oam
* Add parents to model artifacts
* Add top level pom file to distribution
-* Wrong image tag in nonrt-o1-controller distribution pom
+* Wrong image tag in non-rt-ric-o1-controller distribution pom
* Use ONAP release parents directly
* Adjust artifact group name to ORAN naming rule
* Use ORAN parents
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 4f9d174..3ecb51e 100644
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -1,5 +1,13 @@
-sphinx
-sphinx-rtd-theme
-sphinxcontrib-httpdomain
-recommonmark
-lfdocs-conf
\ No newline at end of file
+tox
+Sphinx
+doc8
+docutils < 0.17
+setuptools
+six
+sphinx_rtd_theme
+sphinxcontrib-needs
+sphinxcontrib-swaggerdoc
+sphinx_bootstrap_theme
+sphinxcontrib-redoc
+lfdocs-conf
+urllib3~=1.26.15
diff --git a/tox.ini b/tox.ini
index e35f375..22f612e 100644
--- a/tox.ini
+++ b/tox.ini
@@ -8,13 +8,8 @@
[testenv:docs]
basepython = python3
-deps =
- sphinx
- sphinx-rtd-theme
- sphinxcontrib-httpdomain
- recommonmark
- lfdocs-conf
-
+deps = -r{toxinidir}/docs/requirements-docs.txt
+
commands =
sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
echo "Generated docs available in {toxinidir}/docs/_build/html"
@@ -22,9 +17,5 @@
[testenv:docs-linkcheck]
basepython = python3
-deps = sphinx
- sphinx-rtd-theme
- sphinxcontrib-httpdomain
- recommonmark
- lfdocs-conf
+deps = -r{toxinidir}/docs/requirements-docs.txt
commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
\ No newline at end of file