Fix help Window on all OS #39506
Description
Describe the bug
The new Python help Window (see #39440) behaves inconsistently between different OS and install types. Here is a summary of what happens when opening mantid help:
- Linux conda install: Python widget in offline mode 👍
- Linux tarball install: Unsure, not tested
- Windows conda install: Online docs open in web broswer 👎 (although this is better behaviour than the old behaviour, where it would just crash, see Mantid Help crashes in Windows Conda install #34739)
- Windows .exe install: Online docs open in web broswer 👎
- MacOS conda install: Python widget in offline mode 👍
- MacOS .dmg install: Python widget in online mode 👎
To Reproduce
Install the nightly and open mantid help.
Expected behavior
Consistently on all OS, the help window should open in offline mode when the docs are included in the package.
Additional context
Error messages as follows:
- Windows .exe install
Trying "C:/MantidUnstableInstall/bin/MantidProject.qhc"
QHelp Collection file C:/MantidUnstableInstall/bin/MantidProject.qhc not found
Trying "C:/MantidUnstableInstall/share/html/MantidProject.qhc"
Trying "C:/MantidProject.qhc"
Failed to find help system collection file "MantidProject.qhc"
Using collection file ""
Without collection file redirecting help to default web browser
open url "https://docs.mantidproject.org/index.html"
- Windows conda (similar to standalone):
MantidHelpWindow-[Debug] Trying "C:/Users/tom/AppData/Local/mambaforge/envs/testenv/Library/bin/MantidProject.qhc"
MantidHelpWindow-[Debug] QHelp Collection file C:/Users/tom/AppData/Local/mambaforge/envs/testenv/Library/bin/MantidProject.qhc not found
MantidHelpWindow-[Debug] Trying "C:/Users/tom/AppData/Local/mambaforge/envs/testenv/Library/share/doc/MantidProject.qhc"
MantidHelpWindow-[Debug] Trying "C:/Users/tom/AppData/Local/mambaforge/envs/testenv/share/doc/html/MantidProject.qhc"
MantidHelpWindow-[Information] Failed to find help system collection file "MantidProject.qhc"
MantidHelpWindow-[Debug] Using collection file ""
MantidHelpWindow-[Information] Without collection file redirecting help to default web browser
MantidHelpWindow-[Debug] open url "https://docs.mantidproject.org/index.html"
- MacOS
Local docs path '/Users/mantidbuilder/Jenkins/workspace/build_packages_from_branch/_bundle_build/MantidWorkbenchUnstable.app/Contents/Resources/share/doc/html' from ConfigService ('docs.html.root') is invalid or not found.
Falling back to Online Mode.