Open
Conversation
* Use native web browser to display Help * Use `wxHtmlWindow` to display version information regardless of platform
* Move old files from `doc` folder to `SAM-documentation` repo. These are developer notes on old issues before we had the SAM Documentation repo. * Add new .rst source files for Sphinx-generated Help to `doc` folder. * Delete old HTML help files generated by Help & Manual from `runtime` folder.
Help ID is path to HTML file with no extension <folder>/<filename>. For example Help ID "battery-storage/battery_dispatch_fom" points to battery_dispatch_fom.html in "/help/html/battery-storage" folder.
cpaulgilman
requested review from
mjprilliman,
qualand,
taylorbrown75 and
tyneises
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This is a major reworking of SAM's Help system to migrate from proprietary Help & Manual to open source Sphinx documentation.
For high-level build instructions for Windows, see https://github.com/NatLabRockies/SAM/wiki/Windows-Build-Instructions#9-build-help-optional (also on Mac and Linux build instructions).
For detailed build instructions and information, see https://github.com/NatLabRockies/SAM/blob/help-to-sphinx/README.md.
Fixes #2110
Corresponding branches and PRs:
Build from Develop branches of SSC, WEX, LK and SAM-private.
Unit Test Impact:
None.
Checklist