Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 69adff689080bb439e2c7f8c8993f7c9be383381 / . / tools
tree: 46d702073ce23dd715688095d7bd11f072dbb2b0 [path history] [tgz]
  1. build-c2m.sh
  2. c2m-wrapper.sh
  3. c2m.sh
  4. checkdocs.sh
  5. checkrtd.sh
  6. Dockerfile
  7. example-tox-build-log
  8. example.pagelist
  9. getrsttitle.py
  10. latestbranch.sh
  11. README.md
  12. release_partizipation_210610.csv
  13. release_partizipation_211015.csv
  14. run-c2m.sh
  15. warnstats.sh
  16. wiki_lifecycle_state_210409.txt
  17. wiki_lifecycle_state_210410.txt
  18. wiki_lifecycle_state_210517.txt
  19. wiki_lifecycle_state_211015.txt
tools/README.md

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.

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.

USAGE warnstatst.sh

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.