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

Back-links to GitHub in docs of most stdlibs broken #50035

Open
mauro3 opened this issue Jun 2, 2023 · 7 comments
Open

Back-links to GitHub in docs of most stdlibs broken #50035

mauro3 opened this issue Jun 2, 2023 · 7 comments
Labels
docs This change adds or pertains to documentation docsystem The documentation building system stdlib Julia's standard library

Comments

@mauro3
Copy link
Contributor

mauro3 commented Jun 2, 2023

On https://docs.julialang.org/en/v1/stdlib/DelimitedFiles/ (this is for Julia v1.9) this backlinks to github are broken: clicking on "Edit on GitHub" (top left) and the "source" buttons on each help-box leads to a 404 on GitHub. Maybe todo with the recent move into a separate repo (https://github.com/JuliaData/DelimitedFiles.jl)?

Note that on the Docs https://delimitedfiles.juliadata.org/dev/ the links work.

@mauro3 mauro3 changed the title Source-link in docs of DelimetedFiles broken Back-links to GitHub in docs of DelimetedFiles broken Jun 2, 2023
@LilithHafner LilithHafner added docs This change adds or pertains to documentation stdlib Julia's standard library labels Jun 4, 2023
@LilithHafner
Copy link
Member

I'm observing this for all the stdlibs that I checked except for Pkg.jl. I think this has been known for a while and we should really fix it. This is a great avenue for folks to help us improve documentation and the fact that the links are broken is an unfortunate obstacle in that process.

@LilithHafner LilithHafner changed the title Back-links to GitHub in docs of DelimetedFiles broken Back-links to GitHub in docs of most stdlibs broken Jun 4, 2023
@George9000
Copy link
Contributor

On a locally built julia, which is followed by make docs, all the links to github work in the local html documentation: julia/doc/_build/html/en/index.html.

@Moelf
Copy link
Contributor

Moelf commented Oct 2, 2023

@LilithHafner
Copy link
Member

I'm adding this to the 1.11 milestone because there is an open, mergable PR to fix it. If #47105 doesn't merge by the 1.11 branch point, I think we should merge #51375 as a stop-gap measure.

Maybe we should merge #51375 now and backport it to 1.10 as well? It should be pretty easy to revert once the more general solution is in place.

@LilithHafner
Copy link
Member

@mortenpi, what's the timeline like for #47105 and how back portable is it? (Asking to see if merging #51375 is appropriate, no pressure to hurry)

LilithHafner added a commit that referenced this issue Jan 16, 2024
This is #48814 times 23. It solves most of but not all of #50035.
KristofferC pushed a commit that referenced this issue Jan 24, 2024
This is #48814 times 23. It solves most of but not all of #50035.

(cherry picked from commit a327a95)
@nsajko nsajko added the docsystem The documentation building system label Jan 30, 2024
@KristofferC
Copy link
Member

KristofferC commented Apr 23, 2024

I'm removing this from the milestone since this was the case in 1.9 and the PRs in #50035 (comment) are merged.

This also doesn't seem important enough to withhold a release.

@KristofferC KristofferC removed this from the 1.11 milestone Apr 23, 2024
@LilithHafner
Copy link
Member

Yep! I just wanted to make sure those PRs merged before 1.11 if the general solution hadn't landed (which it still hasn't IIUC)

Drvi pushed a commit to RelationalAI/julia that referenced this issue Jun 7, 2024
This is JuliaLang#48814 times 23. It solves most of but not all of JuliaLang#50035.

(cherry picked from commit a327a95)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation docsystem The documentation building system stdlib Julia's standard library
Projects
None yet
Development

No branches or pull requests

6 participants