search

ipython / ipython

Official repository for IPython itself. Other repos in the IPython organization contain things like the website, documentation builds, etc.
https://ipython.readthedocs.org
BSD 3-Clause "New" or "Revised" License
16.28k stars 4.43k forks source link

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

Open btel opened 4 years ago

btel commented 4 years ago

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 commented 4 years ago

probably related to: https://github.com/readthedocs/sphinx_rtd_theme/pull/393

augustogoulart commented 4 years ago

@meeseeksdev tag good first issue

lumberbot-app[bot] commented 4 years ago

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 commented 4 years ago

@meeseeksdev tag "good first issue"

lumberbot-app[bot] commented 4 years ago

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 commented 4 years ago

@meeseeksdev tag good first issue

omsitapara23 commented 4 years ago

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.

nusart commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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

23kcarlson commented 3 years ago

.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 commented 3 years ago

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