tools/README.md

   1 README FOR ONAP DOC/TOOLS
   2 #########################
   3
   4 c2m.sh
   5 ================================================================================
   6 DESCRIPTION
   7 c2m automates additional tasks required in case you want to export and convert a
   8 set of wiki pages. for more details see header of the script.
   9
  10 USAGE
  11 c2m.sh <your-page-list>
  12
  13 ADDITIONAL FILES
  14 example.pagelist: an example pagelist to demonstrate functionality
  15
  16 SEE ALSO
  17 https://www.viaboxx.de/code/confluence2md/
  18 https://github.com/viaboxxsystems/confluence2md
  19
  20
  21 warnstats.sh
  22 ================================================================================
  23 DESCRIPTION
  24 warnstat helps to find the onap modules (projects) and rst-files which are
  25 responsible for the most warnings during the documentation build process. for
  26 more details see header of the script.
  27
  28 USAGE
  29 warnstatst.sh <your-tox-build-logfile>
  30
  31 NOTES
  32 create the required tox logfile when you locally build the onap documentation:
  33 tox | tee tox-build-logfile
  34
  35 ADDITIONAL FILES
  36 example-tox-build-log: an example tox logfile to demonstrate functionality.
  37 created links in the warnstats output may not work if you use this example.