You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The instructions for building PDF from source repo are difficult to follow and fail: I eventually found https://matplotlib.org/stable/Matplotlib.pdf, but could we make this clearer on the website? I feel like it should be on the homepage (https://matplotlib.org/) so that someone who needs to learn can just instantly access it.
Then doesn't this issue belong on the matplotlib.org repo? B/c it'd be a change to the html there given we apparently already build it if @SuperCowProducts found a link?
ETA: I guess there used to be a link near versions and we could maybe bring something like that back? ETA2: maybe under the cheat sheets?
I checked the matplotlib.org repository and did not find any existing PR adding a visible link to the stable PDF documentation. I would like to propose a clear link to the stable PDF (Matplotlib.pdf).Before proceeding, could you please confirm whether the intended change should be implemented in the matplotlib.org repository (homepage link) or within the main Matplotlib repository documentation? I want to ensure I open the PR in the correct place.
Hi @melissawm , thanks for your guidance earlier :)
I’d like to add a visible link to Matplotlib.pdf for easier access. Could you please confirm whether this should go on the homepage or in the stable docs sidebar? I want to make sure I open the PR in the correct repo.
Hi! I’d like to work on adding a visible link to the PDF documentation near the cheatsheets section, as suggested in the discussion. Please let me know if that sounds good. @story645@timhoffm@melissawm
Hi! I’ve been following the discussion and I understand that the preferred direction is to add a visible link to the PDF documentation near the cheatsheets section.
Before starting any implementation, I just wanted to confirm:
Should the PDF link be added as a secondary button alongside the existing cheatsheet buttons? And should it follow the same theme styling (size, spacing, colors)?
I’d be happy to help once the placement and design direction are finalized.
Acc to the way we have been working on this issue, the goal is to understand the ui. The maintainers are actively helping out in the filtering. Thanks.
I feel like we are using this sidebar as a "put junk we don't know what to do with here", but the proposal seems fine if this is where you are going to put it. I'd just say "PDF docs [18 Mb]" or "PDF documentation" rather than a long sentence...
feel like we are using this sidebar as a "put junk we don't know what to do with here"
I suggested it b/c I thought the link used to live there b/c there used to be a box w/ the versions there. If we want something less prominant, then maybe the footer? Which I think yes, the biggest issue is that it's not really clear where this would be discoverable if we don't make it a button on the homepage.
Cause we have that info in the dropdown, though for a bit we had both.
Thanks @story645@jklymak . Should I proceed with adding a minimal 'PDF docs [18 mb]' link in the sidebar for now? Happy to adjust placement later if needed.
Cause we have that info in the dropdown, though for a bit we had both.
Thanks @story645@jklymak . Should I proceed with adding a minimal 'PDF docs [18 MB]' link in the sidebar for now? Happy to adjust placement later if needed.
Maintainers, I’ve been contributing to Matplotlib recently (a few of my PRs have been merged), and while working on documentation-related issues, I noticed some inconsistencies across documentation versions.
For example, minor version differences (like 3.10.0 vs 3.10.8) are treated quite differently with warning banners, and there are also variations in installation options and UI layout across versions. This can be confusing, especially for beginners.
I’m thinking of focusing my GSoC proposal on improving versioning consistency and reducing this kind of documentation friction.
Would love to get your thoughts on whether this direction seems useful, or if there are specific areas I should focus on?
Would love to get your thoughts on whether this direction seems useful, or if there are specific areas I should focus on?
Can you make this a new issue or discourse topic so it doesn't derail this one. Generally documentation is out of scope for GSoC unless it's heavily infrastructure focused. Also please provide screenshots/links explaining what the issues are, b/c my instinctual response is to wonder if you are confused about how document versioning works.
Activity
story645 commentedon Feb 18, 2026
Which instructions were you trying to follow?
Would adding a link to https://matplotlib.org/devdocs/devel/document.html#build-the-docs from https://matplotlib.org/stable/install/index.html#install-source work or do you think it needs to be more detailed? If so, what sorts of things should be documented and where specifically?
timhoffm commentedon Feb 18, 2026
If I understand correctly, the request is rather to have a link the pdf on there website.
story645 commentedon Feb 18, 2026
Then doesn't this issue belong on the matplotlib.org repo? B/c it'd be a change to the html there given we apparently already build it if @SuperCowProducts found a link?
ETA: I guess there used to be a link near versions and we could maybe bring something like that back? ETA2: maybe under the cheat sheets?
SuperCowProducts commentedon Feb 18, 2026
That sounds like a good idea actually. Thanks for the links also!
timhoffm commentedon Feb 19, 2026
Alternative would be a section "PDF documentation" below https://matplotlib.org/devdocs/index.html#about-us.
SuperCowProducts commentedon Feb 19, 2026
Yeah, somewhere near the cheatsheet pdfs should make sense
Farzah11 commentedon Feb 20, 2026
I checked the matplotlib.org repository and did not find any existing PR adding a visible link to the stable PDF documentation. I would like to propose a clear link to the stable PDF (Matplotlib.pdf).Before proceeding, could you please confirm whether the intended change should be implemented in the matplotlib.org repository (homepage link) or within the main Matplotlib repository documentation? I want to ensure I open the PR in the correct place.
melissawm commentedon Feb 20, 2026
Hi @Farzah11, I'll try to summarize:
So, depending on where you want to include the PDF docs, you should look for a suitable solution in one of these files.
Cheers!
Farzah11 commentedon Feb 22, 2026
Hi @melissawm , thanks for your guidance earlier :)
I’d like to add a visible link to Matplotlib.pdf for easier access. Could you please confirm whether this should go on the homepage or in the stable docs sidebar? I want to make sure I open the PR in the correct repo.
melissawm commentedon Feb 23, 2026
Hi @Farzah11, I think this is part of the solution of the issue: deciding on the best place to put this.
My personal opinion is that next to the cheatsheets works well, but you are welcome to provide your own solution.
Cheers!
story645 commentedon Feb 23, 2026
I think that's three votes for under the cheatsheet pdf? I think give it a day to see if anyone is against, and if not go for it.
I also think that while @SuperCowProducts didn't report a docs issue, #31173 (comment) would be an improvement to the docs.
amishamehta99 commentedon Mar 9, 2026
Hi! I’d like to work on adding a visible link to the PDF documentation near the cheatsheets section, as suggested in the discussion. Please let me know if that sounds good.
@story645 @timhoffm @melissawm
37 remaining items
amishamehta99 commentedon Mar 24, 2026
Acc to the way we have been working on this issue, the goal is to understand the ui. The maintainers are actively helping out in the filtering. Thanks.
aishwaryabnateekar-ui commentedon Mar 24, 2026
Hi! I explored a few UI options and wanted to propose a simple approach.
Proposed idea:
Place a “Download PDF Documentation” link directly below the existing cheatsheets section in the sidebar.
Why this approach:
Implementation idea:
If this direction looks good, I can work on implementing it.
Happy to refine based on feedback!
story645 commentedon Mar 24, 2026
The decision left here is if the different color button idea in #31173 (comment) solves the issue.
I think it's good enough, but would like sign off from at least one other maintainer.
amishamehta99 commentedon Mar 24, 2026
Would love to get feedback from another maintainer when possible.
jklymak commentedon Mar 24, 2026
I feel like we are using this sidebar as a "put junk we don't know what to do with here", but the proposal seems fine if this is where you are going to put it. I'd just say "PDF docs [18 Mb]" or "PDF documentation" rather than a long sentence...
story645 commentedon Mar 25, 2026
I suggested it b/c I thought the link used to live there b/c there used to be a box w/ the versions there. If we want something less prominant, then maybe the footer? Which I think yes, the biggest issue is that it's not really clear where this would be discoverable if we don't make it a button on the homepage.
jklymak commentedon Mar 25, 2026
Why did we remove the version box?
I think we could move ahead w whatever has been decided for now and the someone can go and fix it later
story645 commentedon Mar 25, 2026
Cause we have that info in the dropdown, though for a bit we had both.
amishamehta99 commentedon Mar 25, 2026
Thanks @story645 @jklymak . Should I proceed with adding a minimal 'PDF docs [18 mb]' link in the sidebar for now? Happy to adjust placement later if needed.
amishamehta99 commentedon Mar 25, 2026
Thanks @story645 @jklymak . Should I proceed with adding a minimal 'PDF docs [18 MB]' link in the sidebar for now? Happy to adjust placement later if needed.
amishamehta99 commentedon Mar 25, 2026
Maintainers, I’ve been contributing to Matplotlib recently (a few of my PRs have been merged), and while working on documentation-related issues, I noticed some inconsistencies across documentation versions.
For example, minor version differences (like 3.10.0 vs 3.10.8) are treated quite differently with warning banners, and there are also variations in installation options and UI layout across versions. This can be confusing, especially for beginners.
I’m thinking of focusing my GSoC proposal on improving versioning consistency and reducing this kind of documentation friction.
Would love to get your thoughts on whether this direction seems useful, or if there are specific areas I should focus on?
story645 commentedon Mar 25, 2026
Can you make this a new issue or discourse topic so it doesn't derail this one. Generally documentation is out of scope for GSoC unless it's heavily infrastructure focused. Also please provide screenshots/links explaining what the issues are, b/c my instinctual response is to wonder if you are confused about how document versioning works.
aishwaryabnateekar-ui commentedon Mar 29, 2026
Hi! Based on the discussion so far, it seems we are leaning toward a minimal solution like "PDF docs [18 MB]".
To help move toward consensus, I wanted to clarify:
Should we finalize placement as:
Should we proceed with a simple text link first, and iterate later if needed?
Happy to implement once direction is finalized.
amishamehta99 commentedon Mar 31, 2026
Hi Maintainers. Update on this one? Should we proceed ahead with the changes or stop it here temporarily for sometime?