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

RTD "Edit on Github" broken in "latest" documentation #1023

Closed
gerritholl opened this issue Dec 17, 2019 · 5 comments
Closed

RTD "Edit on Github" broken in "latest" documentation #1023

gerritholl opened this issue Dec 17, 2019 · 5 comments

Comments

@gerritholl
Copy link
Collaborator

Describe the bug

In the Readthedocs online documentation, when I click on "Edit on Github", I get an Error 404 ("This is not the web page you are looking for").

To Reproduce

  1. Go to any page in the Readthedocs online documentation, for example, Adding a custom reader to Satpy. Make sure the version is set to "latest" (see dropdown menu in the bottom left).
  2. In the top right, click on Edit on GitHub

Expected behavior

I would expect to be led to a page where I end up when I click "edit" on https://github.com/pytroll/satpy/blob/master/doc/source/dev_guide/custom_reader.rst, which links to https://github.com/pytroll/satpy/edit/master/doc/source/dev_guide/custom_reader.rst and allows me to edit the file in a textarea window within the GitHub website (it creates a branch in my fork and then a pull request from there).

Actual results

The link leads to https://github.com/pytroll/satpy/blob/origin/master/doc/source/dev_guide/custom_reader.rst, which shows a drawing of a strange figure standing on a beige surface with some oddly shaped buildings (also beige) in the background, with big numbers "404" and a text bubble with the figure saying "This is not the web page you are looking for". When I move my mouse cursor around, the character slightly moves relative to the drawn background.

Although the text bubble is accurate, I am not looking for this peculiar drawing, it is not a useful statement.

Screenshots

image

Environment Info:

  • OS: Linux
  • Satpy Version: Read The Docs "latest" version. When I switch to Read The Docs "stable" version, the edit link works.
@djhoese
Copy link
Member

djhoese commented Dec 17, 2019

From what I can tell sphinx on RTD is adding an extra "origin" to the URL. It should be:

https://github.com/pytroll/satpy/blob/master/doc/source/dev_guide/custom_reader.rst

@gerritholl
Copy link
Collaborator Author

@gerritholl
Copy link
Collaborator Author

Actually, although the stable link works, it leads to an out of date commit.

@djhoese
Copy link
Member

djhoese commented Jan 6, 2020

@gerritholl Can you double check this again? I think this is fixed now on RTD's side of things.

@gerritholl
Copy link
Collaborator Author

@djhoese This appears to work now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants