Ideally, we want to store Help source files (.rst and others) in the SAM repository, but avoid having HTML build files in the repository. We should only build help HTML files for a patch or release.
Possible approach:
- Store source files at SAM/doc.
- Store HTML build files at SAM-private/deploy/runtime/help/html.
This requires:
- Add workfow to automatically build HTML files on push to SAM/Develop or SAM/Patch, and put them in the SAM-private/deploy/runtime/help/html folder for the SAM-private Develop or Patch branch.
This ensures that when we build a release from SAM-private, the HTML help files are up to date, and also makes it possible for us to test Help in non-release builds.
Better option might be to copy HTML files from gh-pages branch of SAM/doc where we store HTML to display from button on SAM website Download page.
Ideally, we want to store Help source files (.rst and others) in the SAM repository, but avoid having HTML build files in the repository. We should only build help HTML files for a patch or release.
Possible approach:
This requires:
This ensures that when we build a release from SAM-private, the HTML help files are up to date, and also makes it possible for us to test Help in non-release builds.
Better option might be to copy HTML files from gh-pages branch of SAM/doc where we store HTML to display from button on SAM website Download page.