NatLabRockies / NatLabRockies/SAM

Consider automating Help build process

Open
#2,222 0 comments 0 reactions 1 assignee View on GitHub

@cpaulgilman is already working on this.

Since Jun 24, 2026.

Dominant language
C++
Stars
486
Forks
219
Avg merge
10h 10m
Merged PRs (30d)
2

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.