Skip to content

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

Closed

Description

@StefRe

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).

Activity

  1. jklymak commented on Sep 9, 2022

    @jklymak
    Member

    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.

  2. timhoffm commented on Sep 9, 2022

    @timhoffm
    Member

    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.

  3. StefRe commented on Sep 9, 2022

    @StefRe
    Author

    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)

  4. StefRe commented on Sep 9, 2022

    @StefRe
    Author

    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).

  5. QuLogic commented on Sep 12, 2022

    @QuLogic
    Member

    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.

  6. jklymak commented on Sep 15, 2022

    @jklymak
    Member

    @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!)

  7. StefRe commented on Sep 16, 2022

    @StefRe
    Author

    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

  8. jklymak commented on Sep 16, 2022

    @jklymak
    Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions