DOC: concise dependency heading + small clarifications #27058
Conversation
63a9257 to
a1a9e37
Compare
|
OK, based on @jklymak's comment I went and looked and there was only one ref I had to updated. Generally we either link to the whole page (which would remain dependencies) or use custom link text geared to the context of the paragraph. That being the case, I really prefer the short titles. Currently the page has longer titles for subheadings and "topic" titles for the subsubheadings: |
|
I agree that the right menu is more verbose than need be, e.g. we don't need "Matplotlib" in there. But the proposed version does not contain the word "dependencies" at all.
I suggest to keep it at least on the section titles:
|
that sounds like a reasonable compromise to me. Going roughly with that, I end up here: (+- tweaks to testing to make it like the others)
Also changed/cleaned up some language and uh I have no idea why that pip/many linux paragraph is in this doc. |
fcdeaa0 to
dc066a0
Compare
dc066a0 to
e60394b
Compare
doc/devel/dependencies.rst
Outdated
|
|
||
| Manual Download | ||
| ^^^^^^^^^^^^^^^ | ||
| Install from source |
There was a problem hiding this comment.
Not quite sure whether "install" is the right term here. But I don't have an alternative either.
There was a problem hiding this comment.
yeah, it was more that Manual download reallly doesn't mean anything here
There was a problem hiding this comment.
use source might be better?
There was a problem hiding this comment.
I don't want to over-think this, but "source" is a quite generic term. IMHO good headings would be
- C libraries
- Automatic download (this section header is missing but should be added)
- Use system libraries
- From source files (or "Custom source files")
There was a problem hiding this comment.
I agree with you so I'll make the change.
There was a problem hiding this comment.
also "Matplotlib vendored version" or the like is probably is better for "Auto download" so I'm going with that.
d2a56c9 to
2d2bef9
Compare
fc5e7d6 to
2d91bb2
Compare
|
Made the changes, but probably would be good for @QuLogic to take a quick glance to make sure I didn't lose anything |
99e3d53 to
2b7439e
Compare
|
@QuLogic does #26621 (comment) mean that I should remove the line about Aix being an exception in the section about MPL vendored freetype? |
|
Yes, I noticed that here, which is why I asked them. Since it looks like we won't need to keep the special-casing, we can drop that from the docs. |
|
Thanks! Also, is the section about pip/manylinux still applicable? |
2b7439e to
93b713b
Compare
|
This part https://github.com/matplotlib/matplotlib/blob/93b713b8b9c1a3f6a180126d22e676313a4940d0/doc/devel/dependencies.rst#minimum-pip--manylinux-support-linux? It has not changed, I don't think. |
|
I think it just didn't feel like it fits w/ the other dependencies, but if it's alright than I don't think there's anything left to change. |
doc/devel/dependencies.rst
Outdated
| in the target environment manually. | ||
| : |
There was a problem hiding this comment.
Not sure why this colon is here?
There was a problem hiding this comment.
accident, but also I went and unpacked the sentences above to try and make it very explicit that most folks should not need to install the build dependencies.
note required MinGW windows header version Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
08426b7 to
0a139a0
Compare
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove the If these instructions are inaccurate, feel free to suggest an improvement. |
|
IMHO not worth a manual backport. |
Yeah this mentions meson and that's milestoned to 3.9. |
PR summary
This PR simplifies the titles of a couple of sections on the dependency page, mostly by removing building and Matplotlib because I think those are a given cause it's the dependency page. It makes the right hand side more scannable.
-->
PR checklist