From 4368806e9b42f57d5d2fecf21f6cb369daa78fa6 Mon Sep 17 00:00:00 2001 From: ktimoney Date: Thu, 29 Jun 2023 15:30:26 +0100 Subject: [PATCH] Correct errors in docs. Issue-ID: NONRTRIC-887 Change-Id: I4b443154aa4642a5f984fa8e0fd93ad0a9f3d2b1 Signed-off-by: ktimoney --- docs/callout-server.rst | 2 +- docs/kafka-message-dispatcher.rst | 2 +- docs/requirements-docs.txt | 5 +++++ docs/simulator-api.rst | 4 ++-- tox.ini | 8 ++++---- 5 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/callout-server.rst b/docs/callout-server.rst index f2556f4..4be73ff 100755 --- a/docs/callout-server.rst +++ b/docs/callout-server.rst @@ -110,7 +110,7 @@ It is possible to manipulate the response of all operations on the external serv POST ++++ -Force a specific response code for the all (the next) external server operation. Unless it is reset, it will always respond the same response code back. +Force a specific response code for the all (the next) external server operation. Unless it is reset, it will always send the same response code back. **URL path:** diff --git a/docs/kafka-message-dispatcher.rst b/docs/kafka-message-dispatcher.rst index 9bfebf7..b0adbfe 100755 --- a/docs/kafka-message-dispatcher.rst +++ b/docs/kafka-message-dispatcher.rst @@ -75,7 +75,7 @@ It is possible to manipulate the response of all operations on the Kafka Message POST ++++ -Force a specific response code for the all (the next) Kafka Message Dispatcher module operations. Unless it is reset, it will always respond the same response code back. +Force a specific response code for the all (the next) Kafka Message Dispatcher module operations. Unless it is reset, it will always send the same response code back. **URL path:** diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 4cfc69f..59e8e0a 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,3 +1,4 @@ +tox sphinx sphinx-rtd-theme sphinx-bootstrap-theme @@ -7,3 +8,7 @@ sphinxcontrib-needs sphinxcontrib-swaggerdoc recommonmark lfdocs-conf +urllib3~=1.26.15 +setuptools +doc8 +docutils < 0.17 diff --git a/docs/simulator-api.rst b/docs/simulator-api.rst index 5449252..f0a512a 100644 --- a/docs/simulator-api.rst +++ b/docs/simulator-api.rst @@ -93,7 +93,7 @@ None. Counters -------- -The simulator keeps counts of different things that can be accessed. +The simulator keeps count of different things that can be accessed. /counter ~~~~~~~~ @@ -286,7 +286,7 @@ Force delay: sec set for all A1 responses Configure logging ----------------- Detailed logging of the http headers and payload are activated by default. However, it is possible to turn this logging on or off. -The 'off' state will only logg ip, url and respose code. +The 'off' state will only log ip, url and respose code. /payload_logging/ ~~~~~~~~~~~~~~~~~ diff --git a/tox.ini b/tox.ini index 3a1149e..ffbcb1b 100644 --- a/tox.ini +++ b/tox.ini @@ -16,12 +16,12 @@ [tox] envlist = code,docs,docs-linkcheck -minversion = 2.0 +minversion = 4.0 skipsdist = true ; basic test and coverage jobs [testenv:code] -basepython = python3.8 +basepython = python3 deps= pytest coverage @@ -48,7 +48,7 @@ commands = # doc jobs [testenv:docs] allowlist_externals = echo -basepython = python3.8 +basepython = python3 deps = -r{toxinidir}/docs/requirements-docs.txt commands = sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html @@ -56,7 +56,7 @@ commands = [testenv:docs-linkcheck] skipsdist = true -basepython = python3.8 +basepython = python3 deps = -r{toxinidir}/docs/requirements-docs.txt commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck -- 2.16.6