Skip to content

[Doc]: Missing source files #23876

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

Closed
StefRe opened this issue Sep 12, 2022 · 5 comments · Fixed by #23919
Closed

[Doc]: Missing source files #23876

StefRe opened this issue Sep 12, 2022 · 5 comments · Fixed by #23919
Milestone

Comments

@StefRe
Copy link
Contributor

StefRe commented Sep 12, 2022

Documentation Link

https://matplotlib.org/devdocs/index.html

Problem

Clicking on "Show Source" results in "Page Not Found" (pertains to any site in the docs, not just the example given above).
grafik

Suggested improvement

Add sources (or remove link).

@tacaswell
Copy link
Member

This is because we intentionally remove _source directory in the circle config https://github.com/matplotlib/matplotlib/blob/main/.circleci/config.yml#L145 . We did that because the store_artifcats uploads a file-at-a-time and we were spending an in ordinate amount of time in that.

Under the old theme I think we had already removed the "show source" link (which I think are of limited value as it is the rst which I have never personally actually wanted). My preference here would be to remove the link in the template with a second choice option of moving the _source directory to hide it from the artifact upload (which leaves the PR build artifacts broken) and then moving it back for the commit.

@tacaswell tacaswell added this to the v3.6.0 milestone Sep 12, 2022
@StefRe
Copy link
Contributor Author

StefRe commented Sep 12, 2022

I don't need the sources online, I just clicked on the link out of curiosity and because I didn't see it before, so removing the "show source" link is fine with me.

@timhoffm
Copy link
Member

While I agree that source links are of limited value and could be removed, there has been work to make these point to GitHub #20673. At least some user and reviewers saw value in the links. This should be considered before removing.

@QuLogic QuLogic modified the milestones: v3.6.0, v3.6.1 Sep 14, 2022
@tacaswell
Copy link
Member

My understanding is that #20673 is the links back to the Python source in the refernce docs. e.g. https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.AbstractMovieWriter.html#matplotlib.animation.AbstractMovieWriter
image

whereas the source links here are to the _source/blah.rst that sphinx adds to the source of page you are looking at.

I think the first are very useful and the second are of limited use.

@timhoffm
Copy link
Member

timhoffm commented Sep 16, 2022

You're right. Me 🐑

we should remove the rst source links.

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.

4 participants