fieldrndservices / libssh2-labview

A LabVIEW library for SSH client support via libssh2
Apache License 2.0
21 stars 2 forks source link

Change to auto-generated HTML Help Documentation #29

Open volks73 opened 3 years ago

volks73 commented 3 years ago

Currently, the HTML Help files that are compiled into a CHM file during the build are part of the source code. These are currently treated as source files because they are "source" for the CHM compiled file. However, the HTML files are in fact generated from the VI descriptions, terminal descriptions, etc. of the VIs, project libraries, classes, etc. documentation and just placed in a template. Originally, the concept was to do HTML file generation once through the Labricator add-on because the thought was that this only had to be done once.

However, whenever the content of the VI documentation is changed because of a bug, typo, or new feature the HTML files should be regenerated, or the change would have to be replicated again in the existing HTML files. Part of the issue was that the Labricator HTML file generation feature was relatively new and experimental. It was implemented and tested in parallel with the development of this toolkit because so many VIs exist and manually "printing" the HTML Help files from each VI was time consuming and error prone. Now, the Labricator HTML file generation feature appears to be more robust and could be used to automatically generate the HTML files as part of the build process. This would eliminate the need to keep all of the HTML files around in the source code.