-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
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
Comments
probably related to: readthedocs/sphinx_rtd_theme#393 |
@meeseeksdev tag good first issue |
Aww augustogoulart, I was not able to apply the following label(s): |
@meeseeksdev tag "good first issue" |
Aww augustogoulart, I was not able to apply the following label(s): |
@meeseeksdev tag good first issue |
HI, Thanks, |
… documentation. Files were blocked in .gitignore which causes them not to be built or put into github.
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. |
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. |
Hello! This is my first time contributing to an open source project , I would like to work on this issue . |
Not sure if I'm looking at the right thing, but the links in the docs this issue mentions are still broken. |
.gitignore contains "docs/source/api/generated" so the pages aren't a part of the repository. |
@23kcarlson that would be the best option, but I'm not sure it is feasible. |
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
The text was updated successfully, but these errors were encountered: