X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=tools%2FREADME.md;h=d62bbaccce905750b262f887e447bfe0fb03e74d;hb=f2714a727afc9c2ac39475a17f0ef473dd17357e;hp=4a407844b5ee3de57c1b7489c6b305ff42f1e64a;hpb=282ff6932bb3dc766c966b83d68d4c9469beac33;p=doc.git 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.