Skip to content

Broken link to "Edit on Github" in ipython documentation #11919

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
btel opened this issue Oct 17, 2019 · 13 comments · Fixed by #12871
Open

Broken link to "Edit on Github" in ipython documentation #11919

btel opened this issue Oct 17, 2019 · 13 comments · Fixed by #12871

Comments

@btel
Copy link
Contributor

btel commented Oct 17, 2019

The API documentation on readthedocs contains a link "Edit on github" in the header. Clicking on the link brings us to a 404 github page:

For example,

Documentation page: https://ipython.readthedocs.io/en/latest/api/generated/IPython.conftest.html

Github link: https://github.com/ipython/ipython/blob/master/docs/source/api/generated/IPython.conftest.rst

@btel btel changed the title Broken link to "Edit on Githbub" in ipython documentation Broken link to "Edit on Github" in ipython documentation Oct 17, 2019
@btel
Copy link
Contributor Author

btel commented Oct 17, 2019

probably related to: readthedocs/sphinx_rtd_theme#393

@augustogoulart
Copy link

@meeseeksdev tag good first issue

@lumberbot-app
Copy link
Contributor

lumberbot-app bot commented Nov 14, 2019

Aww augustogoulart, I was not able to apply the following label(s): good first issue. Either because they are not existing labels on this repository or because you do not have the permission to apply these.I tried my best to guess by looking at the casing, but was unable to find matching labels.

@augustogoulart
Copy link

@meeseeksdev tag "good first issue"

@lumberbot-app
Copy link
Contributor

lumberbot-app bot commented Nov 14, 2019

Aww augustogoulart, I was not able to apply the following label(s): good first issue. Either because they are not existing labels on this repository or because you do not have the permission to apply these.I tried my best to guess by looking at the casing, but was unable to find matching labels.

@augustogoulart
Copy link

@meeseeksdev tag good first issue

@omsitapara23
Copy link

HI,
I would like to work on this issue. I am a first timer so can someone please guide me what exactly needs to be done and how can i approach?

Thanks,
Om.

ghostcodekc added a commit to ghostcodekc/ipython that referenced this issue Oct 6, 2020
… documentation. Files were blocked in .gitignore which causes them not to be built or put into github.
@nusart
Copy link

nusart commented Oct 27, 2020

Hi, @btel I would like to work on this. Can you please assign? Also since I am doing this for the first time, it would be really helpful if you can guide me.

@btel
Copy link
Contributor Author

btel commented Oct 28, 2020

Hi @nusart, since I am not a maintainer of the project, I can not assign you. I did a quick check to understand where the problem comes from, but I couldn't make much progress. I guess you would need to dig into the innerworkings of sphinx and readthedocs template (https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html).

A good first step would be to generate the docs locally and check whether this error appears as well.

@joesinghh
Copy link

Hello! This is my first time contributing to an open source project , I would like to work on this issue .
can i get assigned ?

@MrMino
Copy link
Member

MrMino commented Apr 19, 2021

Not sure if I'm looking at the right thing, but the links in the docs this issue mentions are still broken.

@MrMino MrMino reopened this Apr 19, 2021
@23kcarlson
Copy link

.gitignore contains "docs/source/api/generated" so the pages aren't a part of the repository.
The pages seem to be generated based off of comments in the code, so should the edit button link back to that?

@MrMino
Copy link
Member

MrMino commented Jul 19, 2021

@23kcarlson that would be the best option, but I'm not sure it is feasible.

pratikbhadane24 added a commit to pratikbhadane24/ipython that referenced this issue Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants