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

Links in tutorial.rst don't resolve #2908

Closed
smk78 opened this issue Jun 27, 2024 · 6 comments · Fixed by #2927
Closed

Links in tutorial.rst don't resolve #2908

smk78 opened this issue Jun 27, 2024 · 6 comments · Fixed by #2927
Labels
Defect Bug or undesirable behaviour Documentation Concerns documentation SasView 6.0.0 Required for 6.0.0 release

Comments

@smk78
Copy link
Contributor

smk78 commented Jun 27, 2024

Describe the bug
The links in tutorial.rst from Help > Tutorial don't resolve.

However, SasView/tutorials#15 and SasView/tutorials#14 also need merging and this will change the suffix of some of the filenames to _v6.

@smk78 smk78 added Defect Bug or undesirable behaviour SasView 6.0.0 Required for 6.0.0 release Documentation Concerns documentation labels Jun 27, 2024
@smk78 smk78 changed the title tutorial.rst needs updating Links in tutorial.rst don't resolve Jun 28, 2024
@smk78
Copy link
Contributor Author

smk78 commented Jun 28, 2024

As an example.

Help > Tutorial. Documentation Viewer appears.

Select Getting Started with SasView. Nothing happens.

Right click on hyperlink and copy the address and get:

file:///C:/Users/<user>/.sasview/doc/6.0.0b1/build/html/_downloads/23535589a23be03b8dc873da8cc73adf/getting_started_with_sasview_v5.pdf

Copy this link into a web browser or a file explorer and hit return. It resolves! The file exists at that location.

NB: the file also exists at:

C:\<installation_folder>\doc\build\html\_downloads\23535589a23be03b8dc873da8cc73adf\getting_started_with_sasview_v5.pdf

and

C:\<installation_folder>\doc\source\user\sasview

But if you Edit the tutorials page in the DV you see instead:

:download:`Getting Started with Sasview <sasview/getting_started_with_sasview_v5.pdf>`

@smk78
Copy link
Contributor Author

smk78 commented Jun 28, 2024

I suppose a quick-n-dirty fix would be to just add a sentence at the top of tutorial.rst to say "If these links do not appear to work, copy the link address and paste it into a file/web browser"...

@smk78
Copy link
Contributor Author

smk78 commented Jun 28, 2024

Just trying the same thing in earlier versions of SasView, so not using the Documentation Viewer, all the way back to v5.0.0, and these links don't resolve when you click on them.

This suggests:

  • it's not a Documentation Viewer thing
  • it's not the current version of Sphinx

But I cannot believe these links have never worked; surely someone would have spotted that???

Weird!

@lucas-wilkins
Copy link
Contributor

If its a built in window, this is probably because following external links needs to be enabled. I'll check.

@smk78
Copy link
Contributor Author

smk78 commented Jul 1, 2024

It's a built-in window thing in 6.0.0, but in all v5.x versions a browser would have been spawned.

@smk78
Copy link
Contributor Author

smk78 commented Jul 3, 2024

Help > Tutorials is now fixed. And handling the v6 tutorial naming can be done on the website after 6.0.0 is released.

@krzywon krzywon closed this as completed Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defect Bug or undesirable behaviour Documentation Concerns documentation SasView 6.0.0 Required for 6.0.0 release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants