Skip to content
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

Make Documentation Viewer Accessible Throughout GUI #3097

Merged
merged 8 commits into from
Sep 18, 2024

Conversation

tsole0
Copy link
Contributor

@tsole0 tsole0 commented Aug 28, 2024

Description

Makes the documentation viewer more accessible throughout the entire GUI.

Instead of requiring the documentation viewer widget to be a child of GuiManager, it now has no parent. However, it remains open until it is closed or SasView is closed because it is assigned to a class variable of the GuiManager class, which is always open. If there is already a documentation viewer open, a new (or old but unused) class variable is generated to store the new instance of the documentation window.

Additionally, this allows the GPU preferences Help button to be directed to a documentation viewer instead of being sent to a website. Fixes #2952 and resolves the remaining work from #2909.

How Has This Been Tested?

Tested opening multiple documentation windows together; windows from different parts of the program; and windows that send to pages with section references (#'s).

Review Checklist:

[if using the editor, use [x] in place of [ ] to check a box]

Documentation (check at least one)

  • There is nothing that needs documenting
  • Documentation changes are in this PR
  • There is an issue open for the documentation (link?)

Installers

  • There is a chance this will affect the installers, if so
    • Windows installer (GH artifact) has been tested (installed and worked)
    • MacOSX installer (GH artifact) has been tested (installed and worked)

Licencing (untick if necessary)

  • The introduced changes comply with SasView license (BSD 3-Clause)

@tsole0 tsole0 linked an issue Aug 28, 2024 that may be closed by this pull request
@tsole0
Copy link
Contributor Author

tsole0 commented Aug 28, 2024

I don't know of any other places in the GUI whose help buttons are being sent to a web browser instead of the documentation viewer, but if there are any that I missed those fixes should be included in this PR.

@tsole0 tsole0 added the SasView 6.0.0 Required for 6.0.0 release label Aug 28, 2024
Copy link
Contributor

@krzywon krzywon left a comment

Choose a reason for hiding this comment

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

I made a few suggestions to clean up the code. I tested the functionality and multiple windows are opened, but you should ensure all windows call the new method. The OrientationViewer is still sending the help to the web browser. I would suggest you look for the webbrowser import.

src/sas/qtgui/MainWindow/GuiManager.py Outdated Show resolved Hide resolved
src/sas/qtgui/MainWindow/GuiManager.py Outdated Show resolved Hide resolved
src/sas/qtgui/Utilities/GuiUtils.py Outdated Show resolved Hide resolved
src/sas/qtgui/MainWindow/GuiManager.py Outdated Show resolved Hide resolved
@tsole0 tsole0 requested a review from krzywon September 10, 2024 17:11
@krzywon krzywon merged commit 324e1a6 into release_6.0.0 Sep 18, 2024
30 checks passed
@krzywon krzywon deleted the 2952-make-documentation-viewer-accessible branch September 18, 2024 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SasView 6.0.0 Required for 6.0.0 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Viewer - Make more accessible to all of GUI
2 participants