Skip to content

Fix Help Window path #39826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Fix Help Window path #39826

wants to merge 5 commits into from

Conversation

MohamedAlmaki
Copy link
Contributor

@MohamedAlmaki MohamedAlmaki commented Aug 13, 2025

Description of work

This PR fixes the path of the docs that caused an issue with the offline and online modes in the new Python help window. It also fixes a problem with Qt icons not being shown correctly on Windows. This issue doesn't resolve the conda installation bug on Windows.

Closes #39506.

To test:

  • Development Build
    1- Build this branch locally
    2- Go to Mantid Help
    3- You will see the help docs in online mode and a warning that the docs were not found in the local path
    4- Build docs-html
    5- Rerun Mantid; it should now show the offline docs
    6- Check that all icons are shown correctly

  • Release Build
    Check the unstable build is working as expected https://builds.mantidproject.org/job/build_packages_from_branch/1299


Reviewer

Your comments will be used as part of the gatekeeper process. Comment clearly on what you have checked and tested during your review. Provide an audit trail for any changes requested.

As per the review guidelines:

  • Is the code of an acceptable quality? (Code standards/GUI standards)
  • Has a thorough functional test been performed? Do the changes handle unexpected input/situations?
  • Are appropriately scoped unit and/or system tests provided?
  • Do the release notes conform to the guidelines and describe the changes appropriately?
  • Has the relevant (user and developer) documentation been added/updated?

Gatekeeper

As per the gatekeeping guidelines:

  • Has a thorough first line review been conducted, including functional testing?
  • At a high-level, is the code quality sufficient?
  • Are the base, milestone and labels correct?

@MohamedAlmaki MohamedAlmaki marked this pull request as ready for review August 18, 2025 14:17
@MohamedAlmaki MohamedAlmaki added Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Documentation Issues and pull requests related to documentation labels Aug 18, 2025
@MohamedAlmaki MohamedAlmaki added this to the Release 6.14 milestone Aug 18, 2025
@thomashampson thomashampson self-assigned this Aug 19, 2025
Copy link
Contributor

@thomashampson thomashampson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried installing the Windows .exe from the linked build and it displays only the online docs, with this warning message:
Local docs path '../share/doc/html' from ConfigService ('docs.html.root') is invalid or not found. Falling back to Online Mode.

@MohamedAlmaki
Copy link
Contributor Author

Thanks I will check

@MohamedAlmaki
Copy link
Contributor Author

There was minor issue with the path hopefully this build will fix it: https://builds.mantidproject.org/job/build_packages_from_branch/1301/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Issues and pull requests that are regressions or would be considered a bug by users (e.g. crashing) Documentation Issues and pull requests related to documentation
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Fix help Window on all OS
2 participants