From: Taewan Kim <t25.kim@samsung.com>
Date: Thu, 4 May 2023 06:57:59 +0000 (+0900)
Subject: Fix tox error and update README.md files according to Markdown syntax
X-Git-Tag: 1.1.0~17
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=0ef88329cde7dfc91e50c83bc9d24edd93e8156c;p=aiml-fw%2Fawmf%2Ftm.git

Fix tox error and update README.md files according to Markdown syntax

Issue-ID: AIMLFW-35

Change-Id: Ib0938929252a7cc5fea21764225ce35e15846fa9
Signed-off-by: Taewan Kim <t25.kim@samsung.com>
---

diff --git a/README.md b/README.md
index 03c2c4c..9984ad1 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
+<!--
 # ==================================================================================
 #
 #       Copyright (c) 2022 Samsung Electronics Co., Ltd. All Rights Reserved.
@@ -15,6 +16,11 @@
 #   limitations under the License.
 #
 # ==================================================================================
-#This folder contains all files realted to training manager.
-#To install training maager as package
-pip3 install .
\ No newline at end of file
+-->
+This folder contains all files realted to training manager.
+
+## To install training maager as package
+
+``` bash
+pip3 install .
+```
diff --git a/tests/README.MD b/tests/README.md
similarity index 68%
rename from tests/README.MD
rename to tests/README.md
index 6676825..f586ace 100644
--- a/tests/README.MD
+++ b/tests/README.md
@@ -1,3 +1,4 @@
+<!--
 # ==================================================================================
 #
 #       Copyright (c) 2022 Samsung Electronics Co., Ltd. All Rights Reserved.
@@ -15,30 +16,38 @@
 #   limitations under the License.
 #
 # ==================================================================================
-#Change the current working directory to home directory
-tm
-# Directory struture
-tm
-|__tests
-|__trainingmgr
-|setup.py
+-->
 
+## Directory struture
+```
+tm
+├──tests
+├──trainingmgr
+└──setup.py
+```
 
 ## Prerequisite to run the test cases
+> Change the current working directory to home directory
 Install training manager itself as python package
+``` bash
 pip3 install .
+```
 
 ## Install modelmetricsdk and featurestoresdk as python packages
-  git clone "https://gerrit.o-ran-sc.org/r/aiml-fw/athp/sdk/feature-store" /tmp/fssdk/
-  git clone "https://gerrit.o-ran-sc.org/r/aiml-fw/athp/sdk/model-storage" /tmp/modelsdk/
+``` bash
+git clone "https://gerrit.o-ran-sc.org/r/aiml-fw/athp/sdk/feature-store" /tmp/fssdk/
+git clone "https://gerrit.o-ran-sc.org/r/aiml-fw/athp/sdk/model-storage" /tmp/modelsdk/
 
-  pip3 install /tmp/fssdk/.
-  pip3 install /tmp/modelsdk/.
+pip3 install /tmp/fssdk/.
+pip3 install /tmp/modelsdk/.
+```
 
 ## Install all python dependecy packages
+``` bash
 pip3 install -r requirements_test.txt
+```
 
-# Example to run test cases.
-
-# Generate test report
-python3 -m pytest -rA . --capture=tee-sys --cov-report term-missing --cov-report xml:coverage.xml   --cov-report html:htmlcov --junitxml test-reports/junit.xml --cov=./trainingmgr/
\ No newline at end of file
+## Example to run test cases along with generating test reports.
+``` bash
+python3 -m pytest -rA . --capture=tee-sys --cov-report term-missing --cov-report xml:coverage.xml   --cov-report html:htmlcov --junitxml test-reports/junit.xml --cov=./trainingmgr/
+```
diff --git a/tox.ini b/tox.ini
index 10eb822..3f066ea 100644
--- a/tox.ini
+++ b/tox.ini
@@ -69,7 +69,7 @@ deps =
 commands =
     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
     echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals = echo
+allowlist_externals = echo
 
 [testenv:docs-linkcheck]
 basepython = python3