Help to Sphinx

[cpaulgilman]

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

• requires help revision and I added that label
• adds, removes, modifies, or deletes variables in existing compute modules
• adds a new compute module
• changes defaults
• [ X ] I've tagged this PR to a milestone

[brtietz]

Edit: I was able to debug the issue I posted previously. The path sent to window.cpp is:
file:///C:\Users\bmirletz\source\repos\sam_dev\SAM\deploy\runtime\help\html\pvwatts/pvwatts_location_and_resource.html

The actual path is: "C:\Users\bmirletz\source\repos\sam_dev\SAM\deploy\runtime\help\pvwatts\pvwatts_location_and_resource.html"

I was able to re-run xcopy to get it to work with xcopy .\build\html ..\deploy\runtime\help\html /s Should the Windows build instructions be updated?

[brtietz]

Appears to be a path error with incentives and depreciation: 15:26:08: Error: Failed to open URL "file:///C:\Users\bmirletz\source\repos\sam_dev\SAM\deploy\runtime\help\html\incentives/incentives.html" in default browser. (error 2: The system cannot find the file specified.)

Actual folder name is incentives-and-depreciation

[cpaulgilman]

I was able to re-run xcopy to get it to work with xcopy .\build\html ..\deploy\runtime\help\html /s Should the Windows build instructions be updated?

Yes. That should be fixed now.

[cpaulgilman]

Actual folder name is incentives-and-depreciation

Should be fixed with 15e9f28.

[brtietz]

Thanks for the fixes!

[mjprilliman]

Not sure if we are still looking for review on this, but I just used this branch and the included instructions to update a marine energy cc page and everything worked well.

[janinefreeman]

I think with two reviews we should consider this good to go! @cpaulgilman please feel free to merge in, or we can discuss on Wednesday if it needs to be coordinated with the whole team (i.e. everyone needs to update their build process).