Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Deployed site doesn't correspond to current repo contents #26

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 9, 2022 · 8 comments
Closed

Deployed site doesn't correspond to current repo contents #26

StefRe opened this issue Sep 9, 2022 · 8 comments

Comments

@StefRe
Copy link

StefRe commented Sep 9, 2022

https://matplotlib.org/sampledoc/index.html is outdated and contains some errrors that already have been fixed in the main branch 5 years ago (70f7888).

@jklymak
Copy link
Member

jklymak commented Sep 9, 2022

I had no idea this was even published anywhere. I don't think it is maintained, and seems to have caused some confusion. We should have a proper discussion about whether it should be kept around.

@timhoffm
Copy link
Member

timhoffm commented Sep 9, 2022

I suggest to remove this. Generic documentation how to set up sphinx is not our topic. There are enough resources that cover that.

And even if you don't want plain sphinx, but something more looking like the matplolib docs (maybe because you're a third party package building on top of matplotlib and want a similar look), nowadays the go-to is pydata-sphinx-theme.

@StefRe
Copy link
Author

StefRe commented Sep 9, 2022

I don't think it is maintained

certainly not, see also #25: the only_directive for instance was removed from matplotlib back in 2018 (matplotlib/matplotlib#11295)

@StefRe
Copy link
Author

StefRe commented Sep 9, 2022

I had no idea this was even published anywhere

Neither did I. I just came across it by chance in ipython/ipython#13751 when updating the sphinx docs that refer to that published page (that's why I put a TODO reminder for myself in the PR).

@QuLogic
Copy link
Member

QuLogic commented Sep 12, 2022

The generated contents of this repo are a fixed part of https://github.com/matplotlib/matplotlib.github.com so I guess they only get updated whenever some feels like copying it there. We can set up proper pages hooks to publish and then drop the copy from there if we want, or just remove it.

I guess I'll just put it on the agenda for this week.

@jklymak
Copy link
Member

jklymak commented Sep 15, 2022

@StefRe - We discussed on the call. We would like to mothball this site. Ideally ipython would take whatever they need from this and host in their docs. We will move the useful parts for our purposes to our main docs. But certainly ipython should not be linking to this (it has python 2 code in it, just a a zeroth order check!)

@StefRe
Copy link
Author

StefRe commented Sep 16, 2022

it has python 2 code in it, just a a zeroth order check!

as I said: it's already fixed in the repo and there are some more minor fixes (#25), but the updated version is not published - that was my only point here

@jklymak
Copy link
Member

jklymak commented Sep 16, 2022

The plan is not to publish the site generated here or continue to maintain it.

StefRe added a commit to StefRe/ipython that referenced this issue Sep 16, 2022
Matplotlib decided to not publish this document anymore on their site,
see matplotlib/sampledoc#26 (comment)
@StefRe StefRe closed this as completed Sep 16, 2022
@StefRe StefRe mentioned this issue Sep 16, 2022
StefRe added a commit to StefRe/ipython that referenced this issue Sep 16, 2022
Matplotlib decided to not publish this document anymore on their site,
see matplotlib/sampledoc#26 (comment)
Carreau pushed a commit to StefRe/ipython that referenced this issue Jan 5, 2023
Matplotlib decided to not publish this document anymore on their site,
see matplotlib/sampledoc#26 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants