Skip to content

Documentation is not able to be viewed in new builds #3660

@DrPaulSharp

Description

@DrPaulSharp

Describe the bug
When SasView is freshly built on main, the documentation is not built properly, meaning that an attempt to view it within SasView fails, giving the message "developers please build the documentation and try again."

To Reproduce
Steps to reproduce the behavior:

  1. Install SasView in a new environment
  2. Launch the GUI
  3. Click on "Help>Documentation"
  4. See error

Expected behavior
The documentation should appear.

SasView version (please complete the following information):

  • Version: 6.1.1

Operating system (please complete the following information):

  • OS: Windows 11

Installation method (please complete the following information):

  • Installed: pip

Additional context
I believe this is due to a bug in the routine locate_unpacked_resources in user.py. Note that the initial comment still refers to run.py, which was removed in #3596. Given we have changed the entry point from sasview/run.py to sasview/src/sas/__main__.py, I think it might be the case that line 205 should be changed from exe_dir = Path(sys.argv[0]).parent to exe_dir = Path(sys.argv[0]).parents[2] (i.e., look up two further directories to find the sasview root directory). However, I am not keen to change this without asking for input. Can you help @llimeht?

Image

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions