From f2714a727afc9c2ac39475a17f0ef473dd17357e Mon Sep 17 00:00:00 2001 From: Thomas Kulik Date: Mon, 23 Mar 2020 09:12:25 +0100 Subject: Issue-ID: DOC-595 warnstat.sh V1.5.0: doc8 checks; readability; README Signed-off-by: Thomas Kulik Change-Id: Ifa134696083e90fa40468abb60c21735a6eba5b4 --- tools/README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) (limited to 'tools/README.md') diff --git a/tools/README.md b/tools/README.md index 4a407844b..d62bbaccc 100644 --- a/tools/README.md +++ b/tools/README.md @@ -4,29 +4,34 @@ README FOR ONAP DOC/TOOLS c2m.sh ================================================================================ DESCRIPTION - c2m automates additional tasks required in case you want to export and convert a set of wiki pages. for more details see header of the script. -ADDITIONAL FILES +USAGE +c2m.sh +ADDITIONAL FILES example.pagelist: an example pagelist to demonstrate functionality SEE ALSO - https://www.viaboxx.de/code/confluence2md/ - https://github.com/viaboxxsystems/confluence2md warnstats.sh ================================================================================ DESCRIPTION - warnstat helps to find the onap modules (projects) and rst-files which are responsible for the most warnings during the documentation build process. for more details see header of the script. -ADDITIONAL FILES +USAGE +warnstatst.sh -example-tox-build-log: an example tox logfile to demonstrate functionality +NOTES +create the required tox logfile when you locally build the onap documentation: +tox | tee tox-build-logfile + +ADDITIONAL FILES +example-tox-build-log: an example tox logfile to demonstrate functionality. +created links in the warnstats output may not work if you use this example. -- cgit 1.2.3-korg