From fb8a0eea26492371b52eb08c0433db12ef96cf49 Mon Sep 17 00:00:00 2001 From: Thomas Kulik Date: Wed, 11 Mar 2020 13:13:52 +0100 Subject: doc tools added Issue-ID: DOC-588 Signed-off-by: Thomas Kulik Change-Id: Id9bb976a94d6f7ccd9ff00c623e80e8defc4568d --- tools/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 tools/README.md (limited to 'tools/README.md') diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 000000000..8fe5a04e0 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,32 @@ +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 + +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 + +example-tox-build.log: an example tox logfile to demonstrate functionality -- cgit 1.2.3-korg