Skip to content

DOC: Moved dependencies under install because they're version dependent #27395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Dec 7, 2023
Merged

DOC: Moved dependencies under install because they're version dependent #27395

merged 1 commit into from
Dec 7, 2023
+44 −21

Conversation

story645
Copy link
Member

@story645 story645 commented Nov 29, 2023 •
edited
Loading

PR summary

Based on discussion in #27386 and #22866, it seems consensus is towards the documents under /devel being version independent. Since the dependencies are tracked to the version, I moved the dependencies document from /devel to users/installing/ and updated the cross references. ETA: this move is specifically intended so that dependencies.html does not get caught in a bulk redirect to the development version.

Changes

  • /devel/dependencies -> /users/installing/dependencies
  • changed heading levels so that install FAQ and Troubleshooting are sections of the installation document
  • removed dependencies from /devel/index because its explicitly listed as a step in development_setup
  • removed environment_variables from /devel/index and add a link in the build options section of installation because thats where we mention the other environment variables
  • made environment_variables more prominent under install

My preference would be to move /installing out of /users and make it a top level folder, so doc/install now that /doc is the root documentation folder, but that's out of scope here.

PR checklist

@story645 story645 added Documentation: devdocs files in doc/devel Documentation: user guide files in galleries/users_explain or doc/users labels Nov 29, 2023
@story645 story645 force-pushed the dependencies-install branch 2 times, most recently from 0713d4a to b6ab6d9 Compare November 29, 2023 19:35
@story645 story645 force-pushed the dependencies-install branch 4 times, most recently from 8a616f4 to 9535ca6 Compare November 29, 2023 21:13
@story645 story645 force-pushed the dependencies-install branch from 9535ca6 to 71a7abe Compare November 29, 2023 21:27
@story645
Copy link
Member Author

So I think moving this out to install is an improvement b/c it is part of the general installation process and it helps with scoping '/devel' to docs where only the latest version matters - regardless of whether we end up w/ a bulk redirect or extracting out or just rewriting some links.

@QuLogic QuLogic changed the title DOC: Moved dependencies under install because its version dependent DOC: Moved dependencies under install because they're version dependent Dec 4, 2023
@tacaswell tacaswell merged commit d267a1d into matplotlib:main Dec 7, 2023
@QuLogic QuLogic added this to the v3.9.0 milestone Dec 7, 2023
@story645 story645 deleted the dependencies-install branch December 7, 2023 20:46
@story645
Copy link
Member Author

story645 commented Dec 7, 2023

@QuLogic doesn't this need to be backported to stable if stable gets redirected?

@QuLogic QuLogic modified the milestones: v3.9.0, v3.8-doc Dec 7, 2023
@QuLogic
Copy link
Member

QuLogic commented Dec 7, 2023

Yes, if you want it published to stable, it'll need to be backported. And @ksunden will have to rebuild and push.

@meeseeksdev backport to v3.8.x
@meeseeksdev backport to v3.8.2-doc

@lumberbot-app Lumberbot (App)
Copy link

lumberbot-app bot commented Dec 7, 2023

Owee, I'm MrMeeseeks, Look at me.

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

  1. Checkout backport branch and update it.
git checkout v3.8.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 d267a1d353ba09300a16621364670ec7ebba0fb9
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am "Backport PR #27395: DOC: Moved dependencies under install because they're version dependent"
  1. Push to a named branch:
git push YOURFORK v3.8.x:auto-backport-of-pr-27395-on-v3.8.x
  1. Create a PR against branch v3.8.x, I would have named this PR:

"Backport PR #27395 on branch v3.8.x (DOC: Moved dependencies under install because they're version dependent)"

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

If these instructions are inaccurate, feel free to suggest an improvement.

@lumberbot-app Lumberbot (App)
Copy link

lumberbot-app bot commented Dec 7, 2023

Owee, I'm MrMeeseeks, Look at me.

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

  1. Checkout backport branch and update it.
git checkout v3.8.2-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 d267a1d353ba09300a16621364670ec7ebba0fb9
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am "Backport PR #27395: DOC: Moved dependencies under install because they're version dependent"
  1. Push to a named branch:
git push YOURFORK v3.8.2-doc:auto-backport-of-pr-27395-on-v3.8.2-doc
  1. Create a PR against branch v3.8.2-doc, I would have named this PR:

"Backport PR #27395 on branch v3.8.2-doc (DOC: Moved dependencies under install because they're version dependent)"

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

If these instructions are inaccurate, feel free to suggest an improvement.

story645 pushed a commit to story645/matplotlib that referenced this pull request Dec 8, 2023
@tacaswell @story645
Merge pull request matplotlib#27395 from story645/dependencies-install
dc82334 
DOC: Moved dependencies under install because they're version dependent
(cherry picked from commit d267a1d)
story645 pushed a commit to story645/matplotlib that referenced this pull request Dec 8, 2023
@tacaswell @story645
Merge pull request matplotlib#27395 from story645/dependencies-install
7dd7781 
DOC: Moved dependencies under install because they're version dependent
(cherry picked from commit d267a1d)
@story645 story645 mentioned this pull request Dec 8, 2023
Merged
5 tasks
story645 pushed a commit to story645/matplotlib that referenced this pull request Dec 8, 2023
@tacaswell @story645
Merge pull request matplotlib#27395 from story645/dependencies-install
adcb7a1 
DOC: Moved dependencies under install because they're version dependent
(cherry picked from commit d267a1d)
QuLogic added a commit that referenced this pull request Dec 8, 2023
@QuLogic
Merge pull request #27467 from story645/auto-backport-of-pr-27395-on-…
11715f9 
…v3.8.x

Manual backport of #27395 on v3.8.x
QuLogic added a commit that referenced this pull request Dec 8, 2023
@QuLogic
Merge pull request #27468 from story645/auto-backport-of-pr-27395-on-…
1bf305d 
…v3.8.2-doc

Manual backport of #27395 on v3.8.2-doc
@rcomer rcomer mentioned this pull request Jan 10, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tacaswell tacaswell tacaswell approved these changes

Assignees
No one assigned
Labels
Documentation: devdocs files in doc/devel Documentation: user guide files in galleries/users_explain or doc/users
Projects
None yet
Milestone
v3.8-doc
Development

Successfully merging this pull request may close these issues.
3 participants
@story645 @QuLogic @tacaswell