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

"closes #0000" is in the body of the PR description tolink the related issue
new and changed code istested
Plotting related features are demonstrated in anexample
New Features andAPI Changes are noted with adirective and release note
Documentation complies withgeneral anddocstring guidelines

story645 added the Documentation: devdocsfiles in doc/devel label

Oct 11, 2023

QuLogic reviewed

Oct 11, 2023

View reviewed changes

doc/devel/dependencies.rst OutdatedShow resolvedHide resolved

story645 force-pushed thedep-headings branch 2 times, most recently from63a9257 toa1a9e37Compare

October 11, 2023 03:23

timhoffm reviewed

Oct 11, 2023

View reviewed changes

doc/devel/dependencies.rst OutdatedShow resolvedHide resolved

Copy link

MemberAuthor

story645 commentedOct 11, 2023

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:

Copy link

Member

timhoffm commentedOct 11, 2023

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:

On this page
- Runtime dependencies
  - Mandatory
  - Optional
  - C libraries
  - ...
- Build dependencies
- Test dependencies
- Documentation dependencies

Copy link

MemberAuthor

story645 commentedOct 11, 2023•
edited
Loading

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.

story645 force-pushed thedep-headings branch fromfcdeaa0 todc066a0Compare

October 11, 2023 20:02

story645 changed the title~~DOC: made dependency section headings concise~~DOC: concise dependency heading + small clarifications

Oct 11, 2023

story645 force-pushed thedep-headings branch fromdc066a0 toe60394bCompare

October 11, 2023 20:04

timhoffm approved these changes

Oct 11, 2023

View reviewed changes

Copy link

Member

timhoffm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Take or leave my comments.

doc/devel/dependencies.rst OutdatedShow resolvedHide resolved

doc/devel/dependencies.rst Outdated


		Manual Download
		^^^^^^^^^^^^^^^
		Install from source

Copy link

Member

timhoffmOct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Not quite sure whether "install" is the right term here. But I don't have an alternative either.

Copy link

MemberAuthor

story645Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

yeah, it was more that Manual download reallly doesn't mean anything here

Copy link

MemberAuthor

story645Oct 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

use source might be better?

Copy link

Member

timhoffmOct 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

Copy link

MemberAuthor

story645Oct 17, 2023•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I agree with you so I'll make the change.

Copy link

MemberAuthor

story645Oct 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

also "Matplotlib vendored version" or the like is probably is better for "Auto download" so I'm going with that.

story645 force-pushed thedep-headings branch fromd2a56c9 to2d2bef9Compare

October 11, 2023 20:52

story645 mentioned this pull request

Oct 12, 2023

Added info for getting compilation output from meson on autorebuild#27053

Merged

1 task

story645 force-pushed thedep-headings branch fromfc5e7d6 to2d91bb2Compare

October 12, 2023 17:02

Copy link

MemberAuthor

story645 commentedOct 16, 2023

Made the changes, but probably would be good for@QuLogic to take a quick glance to make sure I didn't lose anything

story645 force-pushed thedep-headings branch 2 times, most recently from99e3d53 to2b7439eCompare

October 17, 2023 00:25

Copy link

MemberAuthor

story645 commentedOct 17, 2023

@QuLogic does#26621 (comment) mean that I should remove the line about Aix being an exception in the section about MPL vendored freetype?

Copy link

Member

QuLogic commentedOct 18, 2023

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.

Copy link

MemberAuthor

story645 commentedOct 18, 2023

Thanks! Also, is the section about pip/manylinux still applicable?

story645 force-pushed thedep-headings branch from2b7439e to93b713bCompare

October 18, 2023 07:02

Copy link

Member

QuLogic commentedOct 18, 2023

This parthttps://github.com/matplotlib/matplotlib/blob/93b713b8b9c1a3f6a180126d22e676313a4940d0/doc/devel/dependencies.rst#minimum-pip--manylinux-support-linux? It has not changed, I don't think.

Copy link

MemberAuthor

story645 commentedOct 18, 2023

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.

QuLogic reviewed

Oct 19, 2023

View reviewed changes

doc/devel/dependencies.rst Outdated

Comment on lines 223 to 224

		in the target environment manually.
		:

Copy link

Member

QuLogicOct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Not sure why this colon is here?

Copy link

MemberAuthor

story645Oct 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.

doc/devel/dependencies.rst OutdatedShow resolvedHide resolved

reduced redundancy in headings and

0a139a0

note required MinGW windows header versionCo-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

story645 force-pushed thedep-headings branch from08426b7 to0a139a0Compare

October 20, 2023 04:18

timhoffm approved these changes

Oct 20, 2023

View reviewed changes

timhoffm added this to thev3.8-doc milestone

Oct 20, 2023

timhoffm merged commitb1857a1 intomatplotlib:main

Oct 20, 2023

Copy link

lumberbot-appbot commentedOct 20, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout v3.8.xgit pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 b1857a13c04beab777f84e0f8810ecd8f5cfc512

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #27058: DOC: concise dependency heading + small clarifications'

Push to a named branch:

git push YOURFORK v3.8.x:auto-backport-of-pr-27058-on-v3.8.x

Create a PR against branch v3.8.x, I would have named this PR:

"Backport PR#27058 on branch v3.8.x (DOC: concise dependency heading + small clarifications)"

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 theStill Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free tosuggest an improvement.

lumberbot-appbot added the Still Needs Manual Backport label

Oct 20, 2023

Copy link

lumberbot-appbot commentedOct 20, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout v3.8.0-docgit pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 b1857a13c04beab777f84e0f8810ecd8f5cfc512

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #27058: DOC: concise dependency heading + small clarifications'

Push to a named branch:

git push YOURFORK v3.8.0-doc:auto-backport-of-pr-27058-on-v3.8.0-doc

Create a PR against branch v3.8.0-doc, I would have named this PR:

"Backport PR#27058 on branch v3.8.0-doc (DOC: concise dependency heading + small clarifications)"

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 theStill Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free tosuggest an improvement.

timhoffm modified the milestones:v3.8-doc,v3.9.0

Oct 20, 2023

timhoffm removed the Still Needs Manual Backport label

Oct 20, 2023

Copy link

Member

timhoffm commentedOct 20, 2023

IMHO not worth a manual backport.

story645 deleted the dep-headings branch

October 20, 2023 13:18

Copy link

MemberAuthor

story645 commentedOct 20, 2023

IMHO not worth a manual backport

Yeah this mentions meson and that's milestoned to 3.9.

Labels

Documentation: devdocs

files in doc/devel

5 participants

Movatterモバイル変換

Uh oh!

DOC: concise dependency heading + small clarifications#27058

DOC: concise dependency heading + small clarifications#27058

Uh oh!

Conversation

story645 commentedOct 11, 2023

PR summary

PR checklist

Uh oh!

Uh oh!

Uh oh!

story645 commentedOct 11, 2023

Uh oh!

timhoffm commentedOct 11, 2023

Uh oh!

story645 commentedOct 11, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timhoffmOct 11, 2023

Choose a reason for hiding this comment

Uh oh!

story645Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

story645Oct 12, 2023

Choose a reason for hiding this comment

Uh oh!

timhoffmOct 16, 2023

Choose a reason for hiding this comment

Uh oh!

story645Oct 17, 2023• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

story645Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

story645 commentedOct 16, 2023

Uh oh!

story645 commentedOct 17, 2023

Uh oh!

QuLogic commentedOct 18, 2023

Uh oh!

story645 commentedOct 18, 2023

Uh oh!

QuLogic commentedOct 18, 2023

Uh oh!

story645 commentedOct 18, 2023

Uh oh!

QuLogicOct 19, 2023

Choose a reason for hiding this comment

Uh oh!

story645Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lumberbot-appbot commentedOct 20, 2023

Uh oh!

lumberbot-appbot commentedOct 20, 2023

Uh oh!

timhoffm commentedOct 20, 2023

Uh oh!

story645 commentedOct 20, 2023

Uh oh!

Uh oh!

story645 commentedOct 11, 2023•
edited
Loading

story645Oct 17, 2023•
edited
Loading