Repository navigation
[Doc]: add old sphinx tutorial to our devdocs #23903
Description
We currently have an interesting tutorial at https://matplotlib.org/sampledoc/index.html. However, it is really old and wrong in places (matplotlib/sampledoc#26) and we think some of this should be in the main developer docs. The todo here is to maybe condense and move this sphinx how-to to the main developer documentation. Probably not too hard, but whoever does it should have some sphinx familiarity and check that it works.
Activity
timhoffm commentedon Sep 17, 2022
The only thing I would keep is „Inserting matplotlib figures“. That’s specific to us. Everything else is standard Sphinx and I don’t see a reason why we should bother to maintain that.
melissawm commentedon Dec 6, 2022
Here's a proposal:
Is this a reasonable way to move forward?
EDIT: Fixed the link to the sphinx/reST tutorial.
story645 commentedon Jul 18, 2024
I'm gonna close this b.c. I think everything in that guide that's mpl specific is already in the doc docs, but folks are free to reopen if there's something they really want. The format here is
sampledoc->doc docsUpside of doing this exercising is understanding where https://matplotlib.org/devdocs/devel/document.html#miscellaneous came from and I think I'm gonna put those back to where they were in the sampledoc structure.
melissawm commentedon Jul 18, 2024
I agree @story645 and after writing this proposal had been thinking of using it as an opportunity to review those docs but I think those are in good shape today. Thanks!
story645 commentedon Jul 18, 2024
Jaunita gave some good feedback on the dev docs/doc docs at sprints that I wanted to start implementing so spun back to this as part of that 😅 #28578 is first stage.