Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change to auto-generated HTML Help Documentation #29

Open
volks73 opened this issue Dec 9, 2020 · 0 comments
Open

Change to auto-generated HTML Help Documentation #29

volks73 opened this issue Dec 9, 2020 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@volks73
Copy link
Member

volks73 commented Dec 9, 2020

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.

@volks73 volks73 added the enhancement New feature or request label Dec 9, 2020
@volks73 volks73 self-assigned this Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant